![\"Run](\"https://run.pstmn.io/button.svg\")
\n\n\nSome of our older APIs are no longer recommended but still available, not\naffecting any existing integration. To find related API documentation, see\n[Older API\nReference](https://developer.zuora.com/v1-api-reference/older-api/overview/).\n\n### More OpenAPI specification options\n\nTo support your integration with our OpenAPI specifications, whether using in-house solutions or third-party tools, we provide the following resources:\n\n- **Order-to-Cash operations (detailed)**: Download Order-to-Cash OpenAPI spec, which includes full descriptions and examples\n- **Order-to-Cash operations (compact)**: Download Order-to-Cash Compact OpenAPI spec, which excludes descriptions and code examples.\n- **Full OpenAPI spec (compact)**: Download Compact OpenAPI Spec, which covers the entire API set without descriptions or samples.\n \nIf you need a different API specification beyond the options above, contact Zuora Global Support, and we will provide a custom spec tailored to your needs.\n"
},
"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.\n",
"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.\n",
"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.\n",
"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.\n\nThe 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).\n\n**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.\n",
"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. \n\nThis section contains the operations that allow you to create, update, get, delete, activate, or deactivate accounting codes in Zuora.\n",
"name": "Accounting Codes"
},
{
"description": "A key step in configuring Finance is to create accounting periods in Zuora to match your company's financial calendar. \nThis 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.\n",
"name": "Accounting Periods"
},
{
"description": "Some operations in this section are similar to each other, but are\nprovided for different use scenarios. You should choose the one that best suits\nyour needs.\n\n\nFor 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.\n\nThe [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.\n",
"name": "Accounts"
},
{
"description": "Delivery Adjustments are used to handle end customer delivery complaints for the Delivery Pricing charge model. For more information, see Delivery Adjustments. \n",
"name": "Delivery Adjustments"
},
{
"description": "The Aggregate Query API (AQuA) is a REST API that executes multiple Export ZOQL or ZOQL queries. The queries are performed in a sequential order and in a single read-only database transaction. \n\nAQuA enforces the following limits:\n\n- 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 best practices for bulk data extraction with AQuA.\n\n- AQuA enforces limits on both the stateful concurrent AQuA jobs and the stateless concurrent AQuA jobs per tenant:\n - The maximum number of stateful concurrent AQuA jobs per tenant is 50. - The maximum number of stateless concurrent AQuA jobs per tenant is 50.\nAQuA jobs in the following status are counted towards your concurrent AQuA job limits:\n - Submitted - Executing\nZuora system will reject the subsequent stateful or stateless job requests once the corresponding concurrent job limit is reached.\n\nFor more information about the Aggregate Query API(AQuA), see Aggregate Query. \n",
"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 APIs dashboard.\n",
"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. \nExample attachments could be purchase orders (PO's), tax exemption document, or ownership transfer forms.\n\nFor more information about attachments, see Attachments.\n",
"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 Bill Run dashboard.\n",
"name": "Bill Run Health"
},
{
"description": "Use the Bill Run call to create ad hoc bill runs and Post, Cancel, Query, and Delete bill runs. \n\nFor more information about bill runs, see Bill runs.\n",
"name": "Bill Run"
},
{
"description": "Billing documents include invoices, credit memos, and debit memos. \n\n**Note**: Credit memos and debit memos are only available if you have the Invoice Settlement feature enabled. \n",
"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. \n\n**Note**: Credit memo item data is only available if you have the Invoice Settlement feature enabled. \n",
"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.\nFor more information, see our latest Commerce API.\n\n\nThe Zuora Billing product catalog is where you define your products\nand pricing. The product catalog's ability to handle sophisticated pricing models\ngives you the power to easily adapt your pricing to customer and market needs,\nto grow your business and drive more revenue. \n",
"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.\nFor more information, see our latest Commerce API.\n\n\nA catalog group is used to group a list of product rate plans with\na specific grade.\n",
"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) \n",
"name": "Configuration Templates"
},
{
"name": "Metadata",
"description": "The Metadata API in Zuora promotes a programmatic way to retrieve, compare, and validate \nmetadata within Zuora tenants for performing create and update actions between the source and the target.\nTo use this API for migrating metadata from a source tenant to a destination tenant, \nyou should authenticate using credentials of the source tenant. \nThe user will have to provide the client id and secret key from the source tenant. \nTo understand the known behavior of configuration templates and APIs, see the following sections:\n[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)\n[Product Catalog deployment FAQs](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AF_Product_Catalog_deployment_FAQs)\n[Deployment Manager Known Facts and Limitations](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/C_Deployment_Manager_Limitations)\n"
},
{
"description": "The Bulk Data API operations allow you to manage bulk data loader services and perform programmatic CRUD (Create, Update, Read/export, Delete) operations. \\\nTo perform data ingestion with a CSV file in Zuora Billing using the Data Loader Bulk Data APIs, see Tutorial for Bulk job API with CSV. \nFor more information, see Process Bulk Job with JSON-lines in Data Loader.\n",
"name": "Bulk Data"
},
{
"description": "The Commerce APIs provide access to product catalog, plans, charges, and order\nmanagement functionality in Zuora. These endpoints are used to create, update,\nand query product rate plans, charges, and dynamic pricing details that drive\nsubscription and billing behavior.\n\nIn a typical use case, the Commerce APIs are called to provision new products\nor plans in the catalog, configure dimensional pricing, or submit orders that\ncreate and modify subscriptions.\n\nChanges made with these APIs affect the product catalog and active subscriptions,\ndepending on the endpoint. Catalog changes update future subscription behavior,\nwhile order operations directly impact customer subscriptions in real time.'\n",
"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. \nThe Commitments API allows you to retrieve details of the commitments a customer has.\n",
"name": "Commitments"
},
{
"description": "Every time a contact is updated a snapshot is taken.\n",
"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.\nClick 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).\n",
"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.\n",
"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.\n\nFor more information about credit memos, see Credit and debit memos.\n",
"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.\n\n**Note**: Event Triggers operations are only applicable to custom events.\n",
"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. \n\nThis feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at Zuora Global Support.\n",
"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.\n\nIf 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. \n\nYou 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.\n\nNote 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.\n\n### Error handling \nIf the Custom Objects API call fails, an error code will be returned in the response body. See See Custom Objects API error code for details.\n",
"name": "Custom Object Definitions"
},
{
"description": "With Custom Objects service, you can create, update, delete and find custom object records.\n\nIf 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. \n\nYou 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.\n\nNote 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.\n\n### Error handling \nIf the Custom Objects API call fails, an error code will be returned in the response body. See Custom Objects API error code for details.\n",
"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.\n\nIf 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. \n\nYou 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.\n\nNote 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.\n\n### Error handling \nIf the Custom Objects API call fails, an error code will be returned in the response body. See Custom Objects API error code for details.\n",
"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.\n\nYou 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).\n\nSee [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.\n\nNote: You can only use the bearer token to access the \"Custom Payment Method Types\" API operations. Access with `apiAccessKeyId` and `apiSecretAccessKey` is not supported.\n",
"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.\n\nFor more information about Custom Scheduled Events, see Custom Scheduled Events.\n",
"name": "Custom Scheduled Events"
},
{
"description": "If you are an Order to Revenue user, you can use the data backfill operations to perform, view or stop data backfill tasks.\n",
"name": "Data Backfill"
},
{
"description": "The Data Labeling APIs help you to label your existing data with organization(s) in Zuora. \n\nOnce 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.\n\nTo 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).\n\nNote that you have to enable the \"Multi Org\" feature before using the Data Labeling APIs. \n\n### General guidelines\n\n* Firstly, create the org hierarchy and determine the data categorization strategy, for example, by currency, by region, by custom fields etc.\n\n* You have to migrate all customer accounts before labeling products in the product catalog\n\n* 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.\n\n### Order of object labeling\n\nExcept for `Account` and `Product`, there are no dependencies between objects, users can label them in parallel.\n\nBut 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.\n\nLikewise, 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.\n\n ### Caveats⚠️\n\nThis API is primarily designed for data migration to assist in labeling existing datasets. \nIt may also serve for data corrections, such as reassigning an account's organizational label, \nthereby transferring the account and its transaction data from one organization to another. \n\n\nIt's important to note that this process does not include business logic validation. \nUsers should exercise caution and judgment when employing this API for data labeling tasks.\n",
"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).\n",
"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.\n\nFor more information about debit memos, see Credit and debit memos.\n",
"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.\n\nBy default, the information returned by the \"Describe an object\" operation corresponds to the latest version of the Zuora WSDL.\n",
"name": "Describe"
},
{
"description": "With the E-Invoicing feature, Zuora supports electronic invoices through an integration with partners that have a local presence, where required, which guarantees compliance with local invoice regulations. \n\nAll the operations in this section are available only if you have the E-Invoicing feature enabled.\n",
"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 Electronic Payments dashboard.\n",
"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 Tax Health Dashboard.",
"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.\n",
"name": "Files"
},
{
"description": "Fulfillments are subordinate objects attached to their related order line item. Fulfillment items are subordinate objects attached to their related fulfillment. \n\nFor more information, see Overview of Order Line Items. \n",
"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. \n\nFor more information, see Hosted Payment Pages.\n",
"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. \n",
"name": "Imports"
},
{
"description": "Use invoice schedules to trigger invoice generation processes. \n\nFor more information about invoice schedules, see Billing Schedule overview.\n",
"name": "Invoice Schedules"
},
{
"description": "Invoices provides information about customers' accounts for invoices, for examples, dates, status, and amounts. \n\nFor more information about invoices, see Invoice.\n",
"name": "Invoices"
},
{
"description": "Use journal runs to automatically create summary journal entities that are suitable for importing into your general ledger system.\n\nFor more information about journal runs, see Journal Runs.\n",
"name": "Journal Runs"
},
{
"description": "Use mass updater to perform mass actions more easily.\n\nFor more information about mass updater, see Mass Updater.\n",
"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.\n\nZuora 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. \n\nNotifications 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)\n * [Create a new Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Create_a_new_Communication_Profile)\n * [Modify a Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Modify_a_Communication_Profile)\n * [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)\n",
"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. \n\nYou 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.\n",
"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.\n 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.\n\n\n\nZuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API. \n\nYou 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.\n\n### Prerequisites\n1. You need to have a One-ID account.\n2. You need to create OAuth 2.0 Clients.\n3. Use the client credentials to generate the bearer token.\n4. Generate the authentication token by hitting the endpoint.\n\n\n### Steps to generate the bearer token\n1. Hit the endpoint to get the token:\n ```bash\n curl --location 'https://one.zuora.com/oauth2/token' \\\n --header 'Content-Type: application/x-www-form-urlencoded' \\\n --data-urlencode 'client_id=52a1d024-b7cc-4d3d-8d0b-dd7b23959e10' \\\n --data-urlencode 'client_secret=aQWDDjn3x9JXbMUQaddvBa2vQQMDCHXL8BgeER8' \\\n --data-urlencode 'grant_type=client_credentials'\n ```\n\n You will get the response as below:\n ```json\n {\n \"access_token\": \"eyJraWQiOiIxNTYwMDBkMi1lY2FjLTQxMGYtOTJmYy02Y2IxMjU1YjQ3NTAiLCJhbGciOiJSUzI1NiJ9.eyIzdWIiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJhdWQiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJuYmYiOjE2OTA1MzcyODksInNjb3BlIjpbImFkbWluIiwiZWMxNDFkYzItOTAxZS00ODEzLWEyNWQtZWY0ODBjZmYxZTI2Il0sImlzcyI6Imh0dHA6XC9cL2xvY2FsaG9zdDo5OTAwIiwiZXhwIjoxNjkwNTQwODg5LCJpYXQiOjE2OTA1MzcyODl9.NMZV-aERA8lTKPPsMtk_WK9ApvX-Bj-6FEIF9GP_duObzdReQkCA2ykcsPSmimw3IbJu7F4XbjZkwTCZL_vBiTaJlnQ7k3hXUzw30b3olDP2Dwc_W6Eh-CvT6s5ZxsFURCZJitfuqh82ezxHdT2lUdcDEMbELw9VpqUSBz0Dqh0tmfnFQyw4yX1be-jflT_0c8SvjyOFGRFScoxcPLq8TrrmpFvgxhT3MqowvQ9butxX6_4mTc3831FnJ6tQIihlBLH4DY11k38x3BBPzb0s9iVcEn7iczWbT0VrSr4A6g1ltATAHNChdzGTqGrhSN8JGG_PPCjJnHY_edaCmcPrUg\",\n \"scope\": \"admin rc141dc2-901e-4813-a25d-ef480cff1e26\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n }\n ```\n2. Use the access token in all the following API calls. Sample curl request:\n ```bash\n curl --location --request GET 'https://one.zuora.com/scim/v2/Schemas' \\\n --header 'Authorization: Bearer eyJraWQiOiIxNTYwMDBkMi1lY2FjLTQxMGYtOTJmYy02Y2IxMjU1YjQ3NTAiLCJhbGciOiJSUzI1NiJ9.eyIzdWIiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJhdWQiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJuYmYiOjE2OTA1MzcyODksInNjb3BlIjpbImFkbWluIiwiZWMxNDFkYzItOTAxZS00ODEzLWEyNWQtZWY0ODBjZmYxZTI2Il0sImlzcyI6Imh0dHA6XC9cL2xvY2FsaG9zdDo5OTAwIiwiZXhwIjoxNjkwNTQwODg5LCJpYXQiOjE2OTA1MzcyODl9.NMZV-aERA8lTKPPsMtk_WK9ApvX-Bj-6FEIF9GP_duObzdReQkCA2ykcsPSmimw3IbJu7F4XbjZkwTCZL_vBiTaJlnQ7k3hXUzw30b3olDP2Dwc_W6Eh-CvT6s5ZxsFURCZJitfuqh82ezxHdT2lUdcDEMbELw9VpqUSBz0Dqh0tmfnFQyw4yX1be-jflT_0c8SvjyOFGRFScoxcPLq8TrrmpFvgxhT3MqowvQ9butxX6_4mTc3831FnJ6tQIihlBLH4DY11k38x3BBPzb0s9iVcEn7iczWbT0VrSr4A6g1ltATAHNChdzGTqGrhSN8JGG_PPCjJnHY_edaCmcPrUg' \\\n --header 'Content-Type: application/json'\n ```\n",
"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.\n\nWith 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.\nYou can also use the `fields[]` query parameter to define which fields are returned in the response for a given object.\nThe `sort[]` query parameter allows you to sort the results in ascending or descending order based on the specified field.\n\nThese parameters are case-insensitive matching.\n\nFor 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/).\n\nFor filterable, expandable, and sortable fields on each object, refer to the Query Parameters section for each API operation.\n",
"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.\n",
"name": "Operations"
},
{
"description": "Orders are contractual agreements between merchants and customers. \n\nYou 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. \nYou can also create order line items to support your non-subscription based business models. \n\nZuora calculates order delta metrics when orders take place. You can retrieve order delta metrics and measure billed and unbilled amounts by order.\n\nFor more information about Orders, see Overview Of Orders. \nTo learn how orders interacts with billing accounts, subscriptions, and product catalog, see [Zuora object model](https://developer.zuora.com/v1-api-reference/object-model/).\n",
"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.\n",
"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.\nFor more information about order line items, see Order Line Items.\n",
"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. \n\nFor more information about payment gateways, see Payment Gateways.\n",
"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. \nFor 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.\n\nYou can complete the following Gateway Reconciliation tasks through API:\n- [Settle a payment](https://developer.zuora.com/api-references/api/operation/POST_SettlePayment/)\n- [Reject a payment](https://developer.zuora.com/api-references/api/operation/POST_RejectPayment/)\n- [Reverse a payment](https://developer.zuora.com/api-references/api/operation/POST_ReversePayment/)\n- [Reconcile a refund](https://developer.zuora.com/api-references/api/operation/POST_ReconcileRefund/)\n",
"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. \nAs such, the Snapshot helps with display of historical transactions, integrations to external systems, and reporting.\n",
"name": "Payment Method Snapshots"
},
{
"description": "The PaymentMethodTransactionLog object contains payment method transaction log data.\n\nYou 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.\n",
"name": "Payment Method Transaction Logs"
},
{
"description": "Payment methods represents payment method details associated with a customer account.\n",
"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 Payment Method Updater.\n",
"name": "Payment Method Updater"
},
{
"description": "Use payment runs to collect payments using electronic payment methods, for example, credit cards and ACH.\nFor more information about payment runs, see Payment Runs.\n",
"name": "Payment Runs"
},
{
"description": "Payment profiles enable payment flexibility for subscribers by allowing payment methods to be associated with specific subscriptions. \n\nTo learn more about the configuration and usage of Payment Profiles, see Payment Profiles. \n",
"name": "Payment Profiles"
},
{
"description": "Use payment schedules to split invoice or account balances into several installments and automatically process payments for the installments.\nFor more information about payment schedules, see Payment Schedules.\n",
"name": "Payment Schedules"
},
{
"description": "Use payment transaction logs to export logs of all transactions from Zuora to the Gateway for Payments.\n",
"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.\n\nYou 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. \nSubsequently, 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.\n",
"name": "Payment Authorization"
},
{
"description": "Use payments to process payments, for example, automate recurring payments, manage overpayments, and create refunds.\nFor more information about payments, see Payments.\n",
"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 Prepaid with Drawdown.\n",
"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.\nFor more information, see our latest Commerce API.\n\n\nUse product charge definitions to define the attributes that can determine\nthe charge behavior, such as billing attributes, pricing attributes, taxation\nattributes, or accounting attributes.\\n\\nThe Product Charge Definition object\nis in the **Early Adopter** phase. We are actively soliciting feedback from\na small set of early adopters before releasing it as generally available. If\nyou are interested, please reach out to your CSM. \n",
"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.\nFor more information, see our latest Commerce API.\n\n\nUse product rate plan definitions to reuse charges in different product\nrate plans. The Product Rate Plan Definition object is in the **Early Adopter**\nphase. We are actively soliciting feedback from a small set of early adopters\nbefore releasing it as generally available. If you are interested, please reach\nout to your CSM. \n",
"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.\nFor more information, see our latest Commerce API.\n\n\nTo manage product rate plan charge tiers, use the [Product Rate Plan\nCharges](https://developer.zuora.com/api-references/api/tag/Product-Rate-Plan-Charges)\noperations instead to update the corresponding product rate plan charge with all\nthe tiers.\n",
"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.\nFor more information, see our latest Commerce API.\n\n\nA product rate plan charge represents a charge model or a set of fees\nassociated with a product rate plan, which is the part of a product that your\ncustomers subscribe to. Each product rate plan can have multiple product rate\nplan charges.\n\n\nProduct rate plan charges can be of three types: one-time fees, recurring fees,\nand usage fees. For example, the $50 activation fee for the Topaz product rate\nplan is a one-time product rate plan charge.\n",
"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.\nFor more information, see our latest Commerce API.\n\n\nA product rate plan is the part of a product that your customers subscribe\nto. Each product can have multiple product rate plans, and each product rate plan\ncan have multiple product rate plan charges, which are fees for products and their\nproduct rate plans.\n",
"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.\n For more information, see our latest Commerce API.\n\n\n A product is an item or service that your company sells. In the subscription\n economy, a product is generally a service that your customers subscribe to rather\n than a physical item that they purchase one time. For example, customers subscribe\n to a service that provides them a car when and where they need a car rather than\n buying a car outright.\n\n\n A Product object contains all of the items in a specific product, especially product\n rate plans and product rate plan charges. Each Product object can have multiple\n rate plans, which in turn can each have multiple rate plan charges. Each rate\n plan charge can have multiple tiers. Taken together, all of these items create\n a single product.\n\n\n Customers subscribe to products that are in your product catalog. Product objects\n collectively compose your product catalog. You create your product catalog by\n creating products. As soon as you create your first product, you create your product\n catalog.\n",
"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.\n\n**Notes**: You must have both the Ramps feature and Orders feature enabled for your tenant to use the Ramps operations.\n\nFor more information, see Ramps and Ramp Metrics.\n",
"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. \nRate plans are sometimes called subscription rate plans. Rate plans that are part of an amendment are sometimes called amendment rate plans.\n\nRate 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.\n",
"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). \nIn addition, you can make electronic refunds using our supported payment gateways, which will automatically refund money to the customer.\n",
"name": "Refunds"
},
{
"description": "If you are an Order to Revenue user, you can use the Regenerate operations to regenerate transactions objects. \n",
"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. \n\nYou 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.\" \n",
"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. \n\nTo create a billing document sequence set through the Zuora UI, see Create Billing Document Sequence Sets for more information.\n",
"name": "Sequence Sets"
},
{
"description": "The Setting API provides a central API for managing settings in your Zuora tenant.\n\nIf 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.\nYou 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.\n",
"name": "Settings"
},
{
"description": "A light-weight API to sign up customers and subscribe. \n\nYou 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.\n",
"name": "Sign Up"
},
{
"description": "A subscription is a product or service that has recurring charges,\nsuch as a monthly flat fee or charges based on usage. Subscriptions can also include\none-time charges, such as activation fees. Every subscription must be associated\nwith an account. At least one active account must exist before any subscriptions\ncan be created.\n\n\nFor more information, see Subscriptions.\n",
"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. \n\nTo create, update, delete, or retrieve an omnichannel subscription, you must turn on the Omni-Channel Subscription feature. For more information, see Omni-Channel Subscription. \n",
"name": "Omnichannel Subscriptions"
},
{
"description": "The change histories of single version subscriptions.\n\n**Note**: To access the change histories, you must turn on the following features:\n\n - Orders\n \n - Single Version Subscription\n",
"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. \n\nFor more information, see Summary Journal Entries Introduction\n",
"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 Account Summary Statements for more information.\n",
"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 Z-Tax or a third-party tax engine such as Avalara or Connect tax engine.\n\nChanges that you make with this object affect the product charges in your product catalog, but not the charges in existing subscriptions.\n",
"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. \nTo make this work, usage must be tracked in the system and usage charges must be calculated and invoiced. \nUsage 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.\n\n### Limitations for dynamic pricing usage charges \n\nLegacy 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. \n\nFor more information about working with usage data, see Usage.\n",
"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.\n\nFor more information, see Workflow.\n",
"name": "Workflows"
},
{
"description": "**Note:** You can only use the operations in this section if you have the Billing - Revenue Integration feature enabled. See Billing - Revenue Integration for more information.\nThe 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 Commerce API.\n",
"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. \nIt returns an ArrayResponse containing TestEnvironmentResponse objects, \nrepresenting the available Test Environments in the system. \n\n### User Access Permission\n\nYou must be assigned the **Refresh Central Sandbox** permission to run \nthis operation.\n"
}
},
"/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. \nIt returns a TestEnvironmentResponse object if the environment is found. If the specified \nTest Environment does not exist, it returns a 404 error.\n\n### User Access Permission\n\nYou must be assigned the **Refresh Central Sandbox** permission to run \nthis operation.\n"
}
},
"/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. \nIt handles HTTP POST requests to the /test-environments/{id}/jobs endpoint, \naccepting a JobRequest object in the request body. Upon successful creation, \nit returns a JobResponse object and sets the Location header to the polling \nURL for the created job.\n\n### User Access Permission\n\nYou must be assigned the **Refresh Central Sandbox** permission to run this operation.\n"
},
"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 \nwith a specific Test Environment. It handles HTTP GET requests to \nthe /test-environments/{id}/jobs endpoint and returns an ArrayResponse \ncontaining JobResponse objects. This method is documented in Swagger, \nincluding possible responses for successful retrieval and bad requests.\n\n### User Access Permission\n\nYou must be assigned the **Refresh Central Sandbox** \npermission to run this operation.\n"
}
},
"/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 \nwith a Test Environment by its unique job ID. It handles \nHTTP GET requests to the /test-environments/{id}/jobs/{jobId} \nendpoint and returns a JobResponse object if the job is found. \nIf the specified job does not exist, it returns a 404 error.\n\n### User Access Permission\n\nYou must be assigned the **Refresh Central Sandbox** permission to run this operation.\n"
}
},
"/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 \non a Test Environment job. It handles HTTP POST \nrequests to the /test-environments/{id}/jobs/{jobId}/actions \nendpoint, accepting a JobActionRequest object in the \nrequest body. Upon successful execution, it returns a \nJobResponse object reflecting the updated job state.\n\n### User Access Permission\n\nYou must be assigned the **Refresh Central Sandbox** permission to run this operation.\n"
}
},
"/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 \nfor a specific Test Environment. It handles HTTP \nPOST requests to the /test-environments/{id}/notifications \nendpoint, accepting a TestEnvironmentNotificationRequest \nobject in the request body. Upon successful creation, \nit returns a TestEnvironmentNotificationResponse object \nand sets the Location header to the URL of the created \nnotification.\n\n### User Access Permission\n\nYou must be assigned the **Refresh Central Sandbox** permission to run this operation.\n"
},
"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 \nwith a specific Test Environment. It handles HTTP GET \nrequests to the /test-environments/{id}/notifications \nendpoint and returns an ArrayResponse containing \nTestEnvironmentNotificationResponse objects. \n\n### User Access Permission\n\nYou must be assigned the **Refresh Central Sandbox** permission to run this operation.\n"
}
},
"/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 \nwith a Test Environment by its unique notification ID. It handles \nHTTP GET requests to the /test-environments/{id}/notifications/{notificationId} \nendpoint and returns a TestEnvironmentNotificationResponse object \nif the notification is found. If the specified notification does \nnot exist, it returns a 404 error.\n\n### User Access Permission\n\nYou must be assigned the **Refresh Central Sandbox** permission to run this operation.\n"
},
"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 \nfor a specific Test Environment. It handles HTTP PATCH \nrequests to the /test-environments/{id}/notifications/{notificationId} \nendpoint, accepting a TestEnvironmentNotificationRequest \nobject in the request body. Upon successful update, it \nreturns a TestEnvironmentNotificationResponse object.\n\n### User Access Permission\n\nYou must be assigned the **Refresh Central Sandbox** permission to run this operation.\n"
},
"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 \nwith a Test Environment. It handles HTTP DELETE requests to the \n/test-environments/{id}/notifications/{notificationId} endpoint \nand returns a TestEnvironmentNotificationResponse object for the \ndeleted notification. If the specified notification does not exist, \nit returns a 404 error.\n\n### User Access Permission\n\nYou must be assigned the **Refresh Central Sandbox** permission to run this operation.\n"
}
},
"/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.\n\n**Note:** When using this operation, do not set any authentication headers such as `Authorization`, `apiAccessKeyId`, or `apiSecretAccessKey`.\n\nYou 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.\n\nFor the rate limit information of authentication, see [Rate and concurrent request limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/).\n",
"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 Multi-entity enabled. \n\nThe value must be a 36-character UUID that contains hyphens(`-`). \nIf your entity ID is not a valid UUID, convert it to a valid UUID before specifying this parameter.\n",
"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.\n",
"maxLength": 36,
"minLength": 36,
"type": "string"
},
"client_secret": {
"description": "The Client Secret that was displayed when the OAuth client was created.\n",
"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`.\n",
"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.\n",
"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.\n",
"schema": {
"type": "integer"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"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.\n",
"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.\n",
"schema": {
"type": "integer"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"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\"\n"
}
]
}
},
"/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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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. \n\nFor 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. \n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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. \n\nThis operation returns a maximum of 300 product rate plans and 300 product rate plan charges across all product rate plans in the response.\n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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/).\n\nCreates a catalog group which groups a list of product rate plans.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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/).\n\nRetrieves basic information about all catalog groups.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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/).\n\nRetrieves basic information about a catalog group.\n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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/).\n\nUpdates a catalog group by its unique number or ID.\n\n### Notes\n- It is best practice to only specify the fields that you want to change in the request body.\n- If you specify an empty value for a field in the request body, the corresponding field in the catalog group is emptied.\n- The catalog group type cannot be changed.\n",
"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. \n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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/).\n\nDeletes a catalog group.\n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n",
"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.\n",
"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.\n\n**Note**: This parameter is applicable only if the Attribute Based Pricing feature is enabled. To access this feature, submit a request at Zuora Global Support.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n",
"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`.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n",
"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`.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\n\nIn 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.\n\n**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. \n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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. \n\n**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. \n",
"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.\n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\n**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. \n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\n**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. \n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n",
"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.\n",
"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.\n\n**Note**: This parameter is applicable only if the Attribute-based Pricing feature is enabled. The Attribute-based Pricing feature in the **Early Adopter** phase. \nWe are actively soliciting feedback from a small set of early adopters. If you are interested, please reach out to your CSM.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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. \n\nProduct rate plan charges can be of three types, one-time fees, recurring fees, and usage fees. \n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\n\nIn the request, you must specify the unique ID or number of the charge for which this charge definition is to be created. \nThe ID or number of a product rate plan is optional.\n\n**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. \n \n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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. \n\n**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. \n",
"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.\n",
"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.\n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\nIn the request, you must specify the unique ID or number of the charge for which this charge definition is to be created. \nThe ID or number of a product rate plan is optional.\n\n**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. \n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\n**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. \n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\n**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. \n",
"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.\n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\n**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. \n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\n**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. \n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\n\nTo 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.\n",
"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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\nUse this endpoint to configure Dynamic Pricing, including default pricing at the charge level \nand conditional rate cards evaluated by attribute values.\n",
"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.\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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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"
}
},
"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.\n",
"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.\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": {
"$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.\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": {
"$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:\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n"
},
"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.\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": {
"$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. \nIf a matching rate-card row is found, its pricing is returned; otherwise, the default charge-level pricing is used (if defined). \nThis operation can be used to simulate pricing resolution without creating or updating the charge.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\nCharges can be usage (per-unit), recurring (flat fee), or other supported models.\n",
"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.\n",
"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\nsuch as name, description, category, effective dates, and custom fields.\n",
"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.\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": {
"$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.\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": {
"$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:\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n"
},
"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.\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": {
"$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.\nA plan includes one or more **charges**. Each charge **must** include:\n - `name`\n - `charge_model`\n - `charge_type`\n - `bill_cycle`\n - `trigger_event`\n - `end_date_condition`\n - `pricing`\n\n Optional charge fields include: `unit_of_measure`, `list_price_base`, and `accounting` (with `accounting_code`, `deferred_revenue_account`, `recognized_revenue_account`).\n",
"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.\n",
"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.\n",
"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:\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\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.",
"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. \nUse this API to update core plan fields such as name, description, grade, and effective dates.\n",
"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.\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.",
"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:\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n"
},
"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.\nThis operation is a **strict lookup** and **requires** `product_rate_plan_key`. It does **not** support `attributes` or other list-style filters.\nTo browse or filter plans (including by `attributes`), use the \"Query product rate plans\" operation (`POST /commerce/plans/list`).\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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. \nYou can optionally expand related Product Rate Plan Charges (PRPCs) in the response.\n",
"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. \nYou can optionally specify related objects to expand in the request body.\n",
"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.\n",
"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\n",
"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.\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": {
"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.\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.",
"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.\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.",
"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\nin the **V1 response format**. It is primarily intended for customers migrating from older V1 integrations \nwho want to use new Commerce capabilities — such as **Dynamic Pricing**—without refactoring their existing integrations.\n\n\nUnlike the \"Query products from the Product Catalog\" operation, this operation does not retrieve a different set of products. \nIt returns the same product catalog data as the newer operation, but formatted in a flattened V1-style response structure that:\n - Uses **flattened fields** instead of grouped objects such as `discount_options`, `revenue`, or `bill_cycle`.\n - Retains **V1 field names** for easier migration from existing V1 operations, for example:\n - Retrieve a product rate plan charge.\n - Retrieve a product rate plan.\n - Retrieve a product.\n - Keeps certain objects, such as `netsuite` and `customFields`, as grouped structures instead of flattening them.\n\n **Recommended Usage** \n - Use this operation if you are migrating from V1 APIs and need to maintain compatibility with existing integrations.\n - For new integrations, use the \"Query products from the Product Catalog\" operation instead, as it returns structured responses optimized for the **Commerce** feature.\n",
"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.\nNote that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` ",
"schema": {
"type": "string"
}
},
"RateLimit-Limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for 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``` 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:\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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**.\n",
"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.\nYou can optionally expand related product rate plan charges (PRPCs) in the response.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"WWW-Authenticate": {
"description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n",
"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.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"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,\nand 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,\ninvoice for that subscription, and collect payment through the default payment method. The transaction is atomic; if any part fails for any reason, the entire\ntransaction is rolled back.\n \nThis operation is CORS Enabled, so you can use client-side Javascript to invoke the call.\n \n### Notes\n\n1. The account is created in active status. \n2. If the `autoPay` field is set to `true` in the request, you must provide one of the `paymentMethod`, `creditCard`, or `hpmCreditCardPaymentMethodId`\nfield, but not multiple. The one provided becomes the default payment method\nfor this account. If the credit card information is declined or cannot be verified,\nno account is created.\n3. Customer accounts created with this call are automatically\nbe set to Auto Pay.\n4. If the `invoiceDeliveryPrefsEmail` field is not specified\nin the request, the account's email delivery preference is always automatically\nset to `false`, no matter whether the `workEmail` or `personalEmail` field\nis specified.\n \n### Defaults for customerAcceptanceDate and serviceActivationDate\n\nDefault values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows.\n\n| | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified |\n| ------------- |:------------- | :-----|\n| 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 |\n| customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default |\n\nThis call supports a subset of the functionality of our [Create an order](https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/) call. \nFor 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.\nThe Orders call has the following advantages: \n- Provides options for managing the entire subscription lifecycle from creation through to cancellation using different order actions. \n- Allows the creation or modifying of multiple subscriptions in a single order. \n- Allows a single order to combine both recurring subscription digital goods or services with order line items for physical goods.\n- Orders are treated as atomic transactions. If any part fails, the entire order, subscription, and billing account creation are rolled back.\n\nYou should use this call if you need to create a standalone billing account, and create orders, subscriptions, standalone invoices, or dynamic usage charges later.\nThere are no deprecation plans for this call and we will continue to support this call for existing users. \n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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. \n\n**Notes and Limitations:** \n- 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. \n- 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 Enable Force Deletion for Account? 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.\n- 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. \n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\nThis 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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\n### Notes\n1. Only the fields to be changed should be specified. Any field that is not included in the request body will not be changed.\n2. If an empty field is submitted with this operation, the corresponding field in the account is emptied.\n3. 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`.\n4. 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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\n**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.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\nBefore you use this API operation, ensure that the Cascading Payment Method feature is enabled. For more information about the Cascading Payment Method feature, see Cascade payment methods.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\nBefore you use this API operation, ensure that the Cascading Payment Method feature is enabled. For more information about the Cascading Payment Method feature, see Cascade payment methods.\n",
"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.\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.\n",
"schema": {
"type": "string"
}
},
"RateLimit-Remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"RateLimit-Reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n",
"schema": {
"type": "number"
}
},
"Zuora-Request-Id": {
"description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n",
"schema": {
"maxLength": 36,
"minLength": 36,
"type": "string"
}
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
},
"Concurrency-Limit-Type": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type"
},
"Concurrency-Limit-Limit": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit"
},
"Concurrency-Limit-Remaining": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining"
}
}
},
"500": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reasons": [
{
"code": "SystemError",
"message": "internal server error"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Content-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": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId"
},
"Zuora-Track-Id": {
"$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId"
}
}
},
"4XX": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"processId": "738CBB9234B47A47",
"reasons": [
{
"code": "58730222",
"message": "orderDate may not be null"
}
],
"requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2",
"success": false
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponse"
}
}
},
"description": "Request Errors",
"headers": {
"Content-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": {
"$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.\n\n**Notes:** **Note:** The value of this column is optional, but the column header is required.
| No |\n| 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.**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.
| No |\n| 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.**Note:** The value of this column is optional, but the column header is required.
| No |\n| 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.**Note:** The value of this column is optional, but the column header is required.
| No |\n| DESCRIPTION | Enter a description for the charge. | No |\n| UNIQUE_KEY | Enter a specific identifier for this usage record. **Note**: This Heading is supported by the following features: Prepaid with Drawdown, and Unbilled Usage. See Upload usage record with unique key for more information. | No |\n", "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.\n", "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "Concurrency-Limit-Limit": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit" }, "Concurrency-Limit-Remaining": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining" } } }, "500": { "content": { "application/json": { "examples": { "response": { "value": { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error", "headers": { "Content-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": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId" }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" } } }, "4XX": { "content": { "application/json": { "examples": { "response": { "value": { "processId": "738CBB9234B47A47", "reasons": [ { "code": "58730222", "message": "orderDate may not be null" } ], "requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2", "success": false } } }, "schema": { "$ref": "#/components/schemas/CommonResponse" } } }, "description": "Request Errors", "headers": { "Content-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": { "$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\"\n" } ] } }, "/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). \n\n**Notes and limitations:**\n- Do not support the Overage Charge Model, Tiered with Overage Charge Model, and Multi-attribute Pricing Charge Model.\n- Do not support invoices in `Cancelled` or `Reversed` status.\n- Do not support Active rating.\n- 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.\n- Do not support [On-demand usage rating](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Rating/On-demand_Usage_Rating). \n- Tax calculation is not involved.\n", "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\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", "quantity": 45, "rateDetail": "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", "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "Concurrency-Limit-Limit": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit" }, "Concurrency-Limit-Remaining": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining" } } }, "500": { "content": { "application/json": { "examples": { "response": { "value": { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error", "headers": { "Content-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": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId" }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" } } }, "4XX": { "content": { "application/json": { "examples": { "response": { "value": { "processId": "738CBB9234B47A47", "reasons": [ { "code": "58730222", "message": "orderDate may not be null" } ], "requestId": "d7479cf6-b410-4630-b841-268ccd48f0d2", "success": false } } }, "schema": { "$ref": "#/components/schemas/CommonResponse" } } }, "description": "Request Errors", "headers": { "Content-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": { "$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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "WWW-Authenticate": { "description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n", "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.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "WWW-Authenticate": { "description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n", "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.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "WWW-Authenticate": { "description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n", "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.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "WWW-Authenticate": { "description": "The value of this header is:\n\n```\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n```\n", "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.\n", "schema": { "maxLength": 36, "minLength": 36, "type": "string" } }, "Zuora-Track-Id": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId" }, "Concurrency-Limit-Type": { "$ref": "#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type" }, "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.\n", "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 }, "previousPage": "null", "nextPage": "null" } } } } } }, "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.\n", "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.\n", "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.\n", "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.\n", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": false, "description": "Page size for pagination.\n", "schema": { "type": "integer", "format": "int32", "default": 30, "maximum": 500 } }, { "name": "cursor", "in": "query", "required": false, "description": "nextPage token from previous response.\n", "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`.\n", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "pageSize", "in": "query", "required": false, "description": "Page size for pagination.\n", "schema": { "type": "integer", "format": "int32", "default": 30, "maximum": 100 } }, { "name": "page", "in": "query", "required": false, "description": "The page number.\n", "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`.\n", "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.\nPossible values:\n - NEVER_RUN\n - TESTING\n - TESTING_FAILED\n - TESTING_PASSED\n - RUNNING\n - PAUSED\n - COMPLETED\n - FAILED\n - CANCELED\n - INITIALIZING\n - USAGE_PUSHING\n - PUSH_COMPLETED\n - CONSUME_COMPLETED \n", "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.\n", "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.\n", "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.\n", "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.\n", "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.\n", "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.\n", "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,\n delimiters, sheets, and data ranges.\n", "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.\n", "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.\n", "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.\n", "schema": { "type": "integer", "format": "int32", "default": 20, "maximum": 50 } }, { "name": "page", "in": "query", "required": false, "description": "The page number.\n", "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": "the account {{DataSource.Account.AccountNumber}} has been edited.
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,
the account {{DataSource.Account.AccountNumber}} has been edited.
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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "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. \n\nThis operation supports creating the email template for all event types.\n\n- 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.\n- 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.\n", "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "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": "{\n \"code\":\"ObjectNotFound\",\n \"message\":\"eventType {com.zuora.notification, AccountEdit} does not exist\"\n}" } }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "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": "{\n \"code\":\"404\",\n \"message\":\"HTTP 404 Not Found\"\n}" } }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "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": "{\n \"code\":\"405\",\n \"message\":\"HTTP 405 Method Not Allowed\"\n}" } }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "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": "{\n \"code\":\"415\",\n \"message\":\"HTTP 415 Unsupported Media Type\"\n}" } }, "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.\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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "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": "{\n \"code\":\"500\",\n \"message\":\"A temporary problem in the service occurred, you can retry later.\"\n}" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error", "headers": { "Content-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.\n", "schema": { "type": "string" } }, "RateLimit-Remaining": { "description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "RateLimit-Reset": { "description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.\n", "schema": { "type": "number" } }, "Zuora-Request-Id": { "description": "The Zuora internal identifier of the API call. You cannot control the value of this header.\n", "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.\n", "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,
the account
Example Co. Ltd.
", "emailHeaders": { "My-Header-1": "Header value 1", "My-Header-2": "Header value 2" }, "emailSubject": "Accountthe invoice
Example Co. Ltd.
", "emailHeaders": { "My-Header-1": "Header value 1", "My-Header-2": "Header value 2" }, "emailSubject": "Invoicethe account
Example Co. Ltd.
", "emailHeaders": { "My-Header-1": "Header value 1", "My-Header-2": "Header value 2" }, "emailSubject": "Account