Some of our older APIs are no longer recommended but still available, not
affecting any existing integration. To find related API documentation, see
[Older API
Reference](https://developer.zuora.com/v1-api-reference/older-api/overview/).
### More OpenAPI specification options
To support your integration with our OpenAPI specifications, whether using in-house solutions or third-party tools, we provide the following resources:
- **Order-to-Cash operations (detailed)**: Download Order-to-Cash OpenAPI spec, which includes full descriptions and examples
- **Order-to-Cash operations (compact)**: Download Order-to-Cash Compact OpenAPI spec, which excludes descriptions and code examples.
- **Full OpenAPI spec (compact)**: Download Compact OpenAPI Spec, which covers the entire API set without descriptions or samples.
If 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.
servers:
- url: https://rest.test.zuora.com
description: US Developer & Central Sandbox (incl. Test Drive)
- url: https://rest.sandbox.na.zuora.com
description: US API Sandbox Cloud 1
- url: https://rest.apisandbox.zuora.com
description: US API Sandbox Cloud 2
- url: https://rest.na.zuora.com
description: US Production Cloud 1
- url: https://rest.zuora.com
description: US Production Cloud 2
- url: https://rest.test.eu.zuora.com
description: EU Developer & Central Sandbox
- url: https://rest.sandbox.eu.zuora.com
description: EU API Sandbox
- url: https://rest.eu.zuora.com
description: EU Production
- url: https://rest.test.ap.zuora.com
description: APAC Developer & Central Sandbox
- url: https://rest.ap.zuora.com
description: APAC Production
security:
- bearerAuth: []
tags:
- description: |
A Test Environment is a dedicated sandbox tenant designed for development, integration, and user acceptance testing of your system configurations and business processes.
name: Test Environments
- description: |
A Test Environment Job represents an asynchronous operation initiated to refresh a Test Environment. These jobs track the status and progress of environment provisioning and refresh.
name: Test Environment Jobs
- description: |
A Test Environment Notification is an automated email dispatched to inform stakeholders when a Test Environment Job is completed or cancelled.
name: Test Environment Notifications
- description: |
Actions are operations that are batch in nature. For example, the "create", "update", "delete", and other operations allow changes to up-to 50 objects at a time. The "query" operation will return up-to 2000 result records back at a time, before requiring additional pages of data to be returned via a subsequent "queryMore" operation.
The default WSDL version for Actions is 79. If you want to change the WSDL version, set the `X-Zuora-WSDL-Version` header. To find out in which WSDL version a particular object or field was introduced, see [Zuora SOAP API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).
**Note**: Actions do not support the Invoice Settlement feature. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. Actions also do not support the Orders feature.
name: Actions
- description: |
Accounting Codes are commonly referred to as General Ledger Accounts or General Ledger Account Codes. In Zuora, the use of accounting codes are optional but recommended.
This section contains the operations that allow you to create, update, get, delete, activate, or deactivate accounting codes in Zuora.
name: Accounting Codes
- description: |
A key step in configuring Finance is to create accounting periods in Zuora to match your company's financial calendar.
This allows Zuora to produce reports and data exports organized by accounting periods, and to perform the work of closing the accounting periods for the revenue sub-ledger.
name: Accounting Periods
- description: |
Some operations in this section are similar to each other, but are
provided for different use scenarios. You should choose the one that best suits
your needs.
For example, the [Retrieve an account](https://developer.zuora.com/v1-api-reference/api/operation/GET_Account/) operation retrieves the basic information of an account, such as bill-to and sold-to contacts, billing and payments setup information, and metrics data for the account.
The [Retrieve an account summary](https://developer.zuora.com/v1-api-reference/api/operation/GET_AccountSummary/) operation returns the more detailed information of an account, such as bill-to and sold-to contacts, subscriptions, invoices, payments, and usages associated with this account.
name: Accounts
- description: |
Delivery Adjustments are used to handle end customer delivery complaints for the Delivery Pricing charge model. For more information, see Delivery Adjustments.
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.
AQuA enforces the following limits:
- The maximum processing time per query is 3 hours. If a query in an AQuA job is executed for longer than 3 hours, this job will be killed automatically. See the best practices for bulk data extraction with AQuA.
- AQuA enforces limits on both the stateful concurrent AQuA jobs and the stateless concurrent AQuA jobs per tenant:
- The maximum number of stateful concurrent AQuA jobs per tenant is 50. - The maximum number of stateless concurrent AQuA jobs per tenant is 50.
AQuA jobs in the following status are counted towards your concurrent AQuA job limits:
- Submitted - Executing
Zuora system will reject the subsequent stateful or stateless job requests once the corresponding concurrent job limit is reached.
For more information about the Aggregate Query API(AQuA), see Aggregate Query.
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.
name: API Health
- description: |
Use attachments in Zuora to upload documents of various formats to associate additional information with accounts, subscriptions, invoices, credit memos, or debit memos.
Example attachments could be purchase orders (PO's), tax exemption document, or ownership transfer forms.
For more information about attachments, see Attachments.
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.
name: Bill Run Health
- description: |
Use the Bill Run call to create ad hoc bill runs and Post, Cancel, Query, and Delete bill runs.
For more information about bill runs, see Bill runs.
name: Bill Run
- description: |
Billing documents include invoices, credit memos, and debit memos.
**Note**: Credit memos and debit memos are only available if you have the Invoice Settlement feature enabled.
name: Billing Documents
- description: |
A billing preview run asynchronously generates a downloadable CSV file containing a preview of future invoice item data and credit memo item data for a batch of customer accounts.
**Note**: Credit memo item data is only available if you have the Invoice Settlement feature enabled.
name: Billing Preview Run
- description: |
**Note** - The APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead.
For more information, see our latest Commerce API.
The Zuora Billing product catalog is where you define your products
and pricing. The product catalog's ability to handle sophisticated pricing models
gives you the power to easily adapt your pricing to customer and market needs,
to grow your business and drive more revenue.
name: Catalog
- description: |
**Note** - The APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead.
For more information, see our latest Commerce API.
A catalog group is used to group a list of product rate plans with
a specific grade.
name: Catalog Groups
- description: |
Configuration Templates in Zuora Deployment Manager enable you to configure your tenants in minutes by importing a templated metadata configuration file. This feature eliminates the need for long manual configuration processes that would have previously taken hours. You will be able to access a comprehensive repository of industry-specific templates. It will be easier for you to deploy and release. To use this API for migrating metadata from a source tenant to a destination tenant, you should authenticate using credentials of the source tenant The user will have to provide the client id and secret key from the sou.rce tenant. To understand the known behavior of configuration templates and APIs, see the following sections: [Product Catalog deployment known facts and system behavior](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AE_Known_facts_and_system_behavior) [Product Catalog deployment FAQs](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AF_Product_Catalog_deployment_FAQs) [Deployment Manager Known Facts and Limitations](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/C_Deployment_Manager_Limitations)
name: Configuration Templates
- name: Metadata
description: |
The Metadata API in Zuora promotes a programmatic way to retrieve, compare, and validate
metadata within Zuora tenants for performing create and update actions between the source and the target.
To use this API for migrating metadata from a source tenant to a destination tenant,
you should authenticate using credentials of the source tenant.
The user will have to provide the client id and secret key from the source tenant.
To understand the known behavior of configuration templates and APIs, see the following sections:
[Product Catalog deployment known facts and system behavior](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AE_Known_facts_and_system_behavior)
[Product Catalog deployment FAQs](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AF_Product_Catalog_deployment_FAQs)
[Deployment Manager Known Facts and Limitations](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/C_Deployment_Manager_Limitations)
- description: |
The Bulk Data API operations allow you to manage bulk data loader services and perform programmatic CRUD (Create, Update, Read/export, Delete) operations. \
To perform data ingestion with a CSV file in Zuora Billing using the Data Loader Bulk Data APIs, see Tutorial for Bulk job API with CSV.
For more information, see Process Bulk Job with JSON-lines in Data Loader.
name: Bulk Data
- description: |
The Commerce APIs provide access to product catalog, plans, charges, and order
management functionality in Zuora. These endpoints are used to create, update,
and query product rate plans, charges, and dynamic pricing details that drive
subscription and billing behavior.
In a typical use case, the Commerce APIs are called to provision new products
or plans in the catalog, configure dimensional pricing, or submit orders that
create and modify subscriptions.
Changes made with these APIs affect the product catalog and active subscriptions,
depending on the endpoint. Catalog changes update future subscription behavior,
while order operations directly impact customer subscriptions in real time.'
name: Commerce
- description: |
A commitment represents a minimum or maximum spend amount a customer is obligated to pay within a spend period, compared with customer's actual fees incurred in connection with customer's accounts and their use of applicable products.
The Commitments API allows you to retrieve details of the commitments a customer has.
name: Commitments
- description: |
Every time a contact is updated a snapshot is taken.
name: Contact Snapshots
- description: |
Configurable Payment Retry APIs use basic authentication. The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.
Click the drop-down arrow at the end of an endpoint to display the full endpoint. To learn more about the configuration and usage of Configurable Payment Retry, see [Configurable Payment Retry](https://knowledgecenter.zuora.com/Zuora_Payments/Configure_payment_orchestration/Payment_Retry/Configurable_Payment_Retry).
name: Configurable Payment Retry
- description: |
A contact defines the customer who holds an account or who is otherwise a person to contact about an account. An account requires a contact for the `BillToId` and `SoldToId` fields before the account can be active.
name: Contacts
- description: |
Credit memos reduce invoice and account balances. By applying one or more credit memos to invoices with positive balances, you can reduce the invoice balances in the same way that applying a payment to an invoice.
For more information about credit memos, see Credit and debit memos.
name: Credit Memos
- description: |
The Event Trigger service manages the business events and trigger conditions that are defined on [Zuora Business Object Model](http://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Zuora_Business_Objects_Relationship) or custom objects. When a Zuora object changes, the trigger conditions defined on the object are evaluated, and if any condition qualifies, a business event will be triggered and turned into a notification.
**Note**: Event Triggers operations are only applicable to custom events.
name: Custom Event Triggers
- description: |
If you use a custom exchange rate provider and upload rates with the Import Foreign Exchange Rates mass action, you can query custom foreign exchange rates from Zuora through API.
This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at Zuora Global Support.
name: Custom Exchange Rates
- description: |
With Custom Objects service, you can define custom objects, extending the Zuora data model to accommodate your specific use cases.
If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works.
You can sign up for a free account on the [Postman website](https://identity.getpostman.com/signup) and download the app in case you do not use Postman yet.
Note that the Custom Object Definitions API is versioned by `Zuora-Version` in the request header. The response may be different for the same request with a different API version. Specify `Zuora-Version` in the request header if you expect a specific response schema.
### Error handling
If the Custom Objects API call fails, an error code will be returned in the response body. See See Custom Objects API error code for details.
name: Custom Object Definitions
- description: |
With Custom Objects service, you can create, update, delete and find custom object records.
If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works.
You can sign up for a free account on the [Postman website](https://identity.getpostman.com/signup) and download the app in case you do not use Postman yet.
Note that the Custom Object Records API is versioned by `Zuora-Version` in the request header. The response may be different for the same request with a different API version. Specify `Zuora-Version` in the request header if you expect a specific response schema.
### Error handling
If the Custom Objects API call fails, an error code will be returned in the response body. See Custom Objects API error code for details.
name: Custom Object Records
- description: |
With Custom Objects service, you can submit a bulk job request to create, update, or delete custom object records in a batch.
If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works.
You can sign up for a free account on the [Postman website](https://identity.getpostman.com/signup) and download the app in case you do not use Postman yet.
Note that the Custom Object Jobs API is versioned by `Zuora-Version` in the request header. The response may be different for the same request with a different API version. Specify `Zuora-Version` in the request header if you expect a specific response schema.
### Error handling
If the Custom Objects API call fails, an error code will be returned in the response body. See Custom Objects API error code for details.
name: Custom Object Jobs
- description: |
Open Payment Method (OPM) service is a framework developed by Zuora, which allows you to integrate your custom payment method to Zuora subscription, billing, and revenue management in a dynamic and flexible manner. With the support of the OPM service, you are able to define your custom payment method types and create custom payment methods of the defined types. The custom payment method of the defined type can only be used with the custom payment gateway that you set up through the Universal Payment Connector (UPC) service. It cannot be used with the Zuora out-of-box gateway integrations such as GoCardless, Stripe, etc.
You can define up to 20 custom payment method types for one tenant. Do not define your fields with the [Zuora-reserved fields](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods/C_Configure_and_manage_your_custom_payment_method_types_through_Zuora_REST_APIs#Zuora-reserved_fields).
See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for more information about the OPM and UPC services.
Note: You can only use the bearer token to access the "Custom Payment Method Types" API operations. Access with `apiAccessKeyId` and `apiSecretAccessKey` is not supported.
name: Custom Payment Method Types
- description: |
A custom scheduled event notification is evaluated at the scheduled time of the related scheduled event on a daily basis. If the date meets the combination of the base field and the notification parameters, the notification will be triggered immediately.
For more information about Custom Scheduled Events, see Custom Scheduled Events.
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.
name: Data Backfill
- description: |
The Data Labeling APIs help you to label your existing data with organization(s) in Zuora.
Once you turned on Multi Org feature, if you don't label your existing data, they are simply unlabeled, and unlabeled data can be accessed by all organizations in your tenant.
To limit the access of your existing data, you need to label them with organization(s) you defined in the organization hierarchy management setting page. Once labeled, the data can only be accessed by users who have been granted with the labeled organization(s).
Note that you have to enable the "Multi Org" feature before using the Data Labeling APIs.
### General guidelines
* Firstly, create the org hierarchy and determine the data categorization strategy, for example, by currency, by region, by custom fields etc.
* You have to migrate all customer accounts before labeling products in the product catalog
* You can leave the users at the root, just so long as you understand that the user would have access to all the Org Units within the Multi-org enabled tenant.
### Order of object labeling
Except for `Account` and `Product`, there are no dependencies between objects, users can label them in parallel.
But please keep in mind that the data access control ensues from the object labeling. For example, if you label a scheduled `BillRun` with `US` org, when it's triggered next time, the bill run will only pick up customer accounts of the `US` org, not others.
Likewise, labeling a user will change the user's visible data scope, for example, an `EU` user won't be able to see `US` accounts anymore.
### Caveats⚠️
This API is primarily designed for data migration to assist in labeling existing datasets.
It may also serve for data corrections, such as reassigning an account's organizational label,
thereby transferring the account and its transaction data from one organization to another.
It's important to note that this process does not include business logic validation.
Users should exercise caution and judgment when employing this API for data labeling tasks.
name: Data Labeling
- description: |
The Data Query feature enables you to perform SQL queries in your Zuora tenant. To learn how to get started with Data Query, see [Overview of Data Query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/A_Overview_of_Data_Query).
name: Data Queries
- description: |
Debit memos increase the amount a customer owes. It is a separate document from the invoice. Debit memos can be used to correct undercharging on an invoice or to levy ad hoc charges outside the context of a subscription. Just like an invoice, debit memo balances can be settled by applying either a payment or a credit memo.
For more information about debit memos, see Credit and debit memos.
name: Debit Memos
- description: |
You can use the [Describe an object](https://developer.zuora.com/v1-api-reference/api/operation/GET_Describe/) operation to get a reference listing of each object that is available in your Zuora tenant.
By default, the information returned by the "Describe an object" operation corresponds to the latest version of the Zuora WSDL.
name: Describe
- description: |
With the 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.
All the operations in this section are available only if you have the E-Invoicing feature enabled.
name: E-Invoicing
- description: |
Zuora System Health dashboard for Electronic Payments (Electronic Payment dashboard) collects and displays usage, failure, and performance data about electronic payments in near real time. It enables you to view all the electronic payments in your Zuora tenant within the last 30 days. For more information, see Electronic Payments dashboard.
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.
name: Files
- description: |
Fulfillments are subordinate objects attached to their related order line item. Fulfillment items are subordinate objects attached to their related fulfillment.
For more information, see Overview of Order Line Items.
name: Fulfillments
- description: |
Hosted payment pages allow your customers to set up a payment method, such as providing a credit card. Since it only handles the payment method, it is suitable for a simple workflow or a complex multi-page, multi-product workflow.
For more information, see Hosted Payment Pages.
name: Hosted Pages
- description: |
An import uploads content, especially when you have a large amount of content. The Import object contains all of the information you need to upload content, such as a large number of usage records.
name: Imports
- description: |
Use invoice schedules to trigger invoice generation processes.
For more information about invoice schedules, see Billing Schedule overview.
name: Invoice Schedules
- description: |
Invoices provides information about customers' accounts for invoices, for examples, dates, status, and amounts.
For more information about invoices, see Invoice.
name: Invoices
- description: |
Use journal runs to automatically create summary journal entities that are suitable for importing into your general ledger system.
For more information about journal runs, see Journal Runs.
name: Journal Runs
- description: |
Use mass updater to perform mass actions more easily.
For more information about mass updater, see Mass Updater.
name: Mass Updater
- description: |
Notifications are the actions taken to inform users or call third-party endpoints when a certain event happens. Typical actions include emails and callouts. Callouts typically refer to HTTP invocations, such as HTTP calls to REST services.
Zuora notification system processes the events in the same order in which they are triggered. The timing and delivery of notifications can still vary based on factors such as retries, concurrency, and network latency. But Zuora guarantees the best performance possible with the right performance boosters and tuning.
Notifications are associated with Communication Profiles, which allow you to send specific event-driven notifications to targeted customers. Zuora provides the following Settings API to access the settings of Communication Profiles:* [Get all Communication Profiles](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Get_all_Communication_Profiles)
* [Create a new Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Create_a_new_Communication_Profile)
* [Modify a Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Modify_a_Communication_Profile)
* [Get all Notifications under a particular Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Get_all_Notifications_under_a_particular_Communication_Profile)
name: Notifications
- description: The Zuora Mediation APIs provide a comprehensive set of endpoints to manage, test, run, and monitor usage meters. These APIs support actions such as running or testing specific meter versions, importing and exporting meter configurations, managing input files, performing event store operations, and ingesting usage data in real time via streaming. All APIs follow a consistent response structure to simplify integration and error handling. Use these APIs to automate and streamline your usage processing pipeline—from data ingestion to transformation and billing.
name: Meters
- description: |
Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API.
You must first create an OAuth client in the Zuora UI before using the [Create an OAuth token](https://developer.zuora.com/api-references/api/operation/createToken) operation to create an OAuth token. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/) for more information.
name: OAuth
- description: |
System for Cross-domain Identity Management, or SCIM, is an API specification created to facilitate the management of people and groups of people in cloud-based applications and services.
Universal Identity SCIM API is built on top of the SCIM 2.0 specification and can be integrated with major Identity Providers like Okta, Microsoft Entra ID and OneLogin.
Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API.
You must first create an OAuth client in the Zuora UI before using the [Create an OAuth token](https://developer.zuora.com/api-references/api/operation/createToken) operation to create an OAuth token. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/) for more information.
### Prerequisites
1. You need to have a One-ID account.
2. You need to create OAuth 2.0 Clients.
3. Use the client credentials to generate the bearer token.
4. Generate the authentication token by hitting the endpoint.
### Steps to generate the bearer token
1. Hit the endpoint to get the token:
```bash
curl --location 'https://one.zuora.com/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=52a1d024-b7cc-4d3d-8d0b-dd7b23959e10' \
--data-urlencode 'client_secret=aQWDDjn3x9JXbMUQaddvBa2vQQMDCHXL8BgeER8' \
--data-urlencode 'grant_type=client_credentials'
```
You will get the response as below:
```json
{
"access_token": "eyJraWQiOiIxNTYwMDBkMi1lY2FjLTQxMGYtOTJmYy02Y2IxMjU1YjQ3NTAiLCJhbGciOiJSUzI1NiJ9.eyIzdWIiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJhdWQiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJuYmYiOjE2OTA1MzcyODksInNjb3BlIjpbImFkbWluIiwiZWMxNDFkYzItOTAxZS00ODEzLWEyNWQtZWY0ODBjZmYxZTI2Il0sImlzcyI6Imh0dHA6XC9cL2xvY2FsaG9zdDo5OTAwIiwiZXhwIjoxNjkwNTQwODg5LCJpYXQiOjE2OTA1MzcyODl9.NMZV-aERA8lTKPPsMtk_WK9ApvX-Bj-6FEIF9GP_duObzdReQkCA2ykcsPSmimw3IbJu7F4XbjZkwTCZL_vBiTaJlnQ7k3hXUzw30b3olDP2Dwc_W6Eh-CvT6s5ZxsFURCZJitfuqh82ezxHdT2lUdcDEMbELw9VpqUSBz0Dqh0tmfnFQyw4yX1be-jflT_0c8SvjyOFGRFScoxcPLq8TrrmpFvgxhT3MqowvQ9butxX6_4mTc3831FnJ6tQIihlBLH4DY11k38x3BBPzb0s9iVcEn7iczWbT0VrSr4A6g1ltATAHNChdzGTqGrhSN8JGG_PPCjJnHY_edaCmcPrUg",
"scope": "admin rc141dc2-901e-4813-a25d-ef480cff1e26",
"token_type": "Bearer",
"expires_in": 3600
}
```
2. Use the access token in all the following API calls. Sample curl request:
```bash
curl --location --request GET 'https://one.zuora.com/scim/v2/Schemas' \
--header 'Authorization: Bearer eyJraWQiOiIxNTYwMDBkMi1lY2FjLTQxMGYtOTJmYy02Y2IxMjU1YjQ3NTAiLCJhbGciOiJSUzI1NiJ9.eyIzdWIiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJhdWQiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJuYmYiOjE2OTA1MzcyODksInNjb3BlIjpbImFkbWluIiwiZWMxNDFkYzItOTAxZS00ODEzLWEyNWQtZWY0ODBjZmYxZTI2Il0sImlzcyI6Imh0dHA6XC9cL2xvY2FsaG9zdDo5OTAwIiwiZXhwIjoxNjkwNTQwODg5LCJpYXQiOjE2OTA1MzcyODl9.NMZV-aERA8lTKPPsMtk_WK9ApvX-Bj-6FEIF9GP_duObzdReQkCA2ykcsPSmimw3IbJu7F4XbjZkwTCZL_vBiTaJlnQ7k3hXUzw30b3olDP2Dwc_W6Eh-CvT6s5ZxsFURCZJitfuqh82ezxHdT2lUdcDEMbELw9VpqUSBz0Dqh0tmfnFQyw4yX1be-jflT_0c8SvjyOFGRFScoxcPLq8TrrmpFvgxhT3MqowvQ9butxX6_4mTc3831FnJ6tQIihlBLH4DY11k38x3BBPzb0s9iVcEn7iczWbT0VrSr4A6g1ltATAHNChdzGTqGrhSN8JGG_PPCjJnHY_edaCmcPrUg' \
--header 'Content-Type: application/json'
```
name: SCIM
- description: |
The Object Query API contains GET operations that allow you to query objects in your Zuora tenant in an efficient, consistent, and flexible manner.
With the `expand[]` and `filter[]` query parameters, you have the flexibility to retrieve related object information in a single call and define the returned response that best suits your needs.
You can also use the `fields[]` query parameter to define which fields are returned in the response for a given object.
The `sort[]` query parameter allows you to sort the results in ascending or descending order based on the specified field.
These parameters are case-insensitive matching.
For general Object Queries limitations and comprehensive introduction to these query parameters, see [Expand, filter, fields, and sort](https://developer.zuora.com/docs/guides/expand-filter-fields-sort/).
For filterable, expandable, and sortable fields on each object, refer to the Query Parameters section for each API operation.
name: Object Queries
- description: |
Use operations to generate invoices and credit memos, collect payments for posted invoices, and generate previews of future invoice items for customer accounts.
name: Operations
- description: |
Orders are contractual agreements between merchants and customers.
You can create multiple subscriptions and subscription amendments at once in a single order. All the operations on subscriptions in orders are done by order actions.
You can also create order line items to support your non-subscription based business models.
Zuora calculates order delta metrics when orders take place. You can retrieve order delta metrics and measure billed and unbilled amounts by order.
For more information about Orders, see Overview Of Orders.
To learn how orders interacts with billing accounts, subscriptions, and product catalog, see [Zuora object model](https://developer.zuora.com/v1-api-reference/object-model/).
name: Orders
- description: |
You need to have the [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders/Orders_Harmonization) feature enabled to use this API.
name: Order Actions
- description: |
Use order line item to launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models.
For more information about order line items, see Order Line Items.
name: Order Line Items
- description: |
Use payment gateways to pass authorization, payments, and settlement data securely to and from the merchant's website to the merchant's processor.
For more information about payment gateways, see Payment Gateways.
name: Payment Gateways
- description: |
Gateway reconciliation is the process of verifying that the electronic payment and refund transactions processed in Zuora match the transactions reported by the gateway.
For example, if Zuora processed 200 transactions through a gateway, you should see the same number of transactions on the gateway's reconciliation report, sometimes also called the settlement report.
You can complete the following Gateway Reconciliation tasks through API:
- [Settle a payment](https://developer.zuora.com/api-references/api/operation/POST_SettlePayment/)
- [Reject a payment](https://developer.zuora.com/api-references/api/operation/POST_RejectPayment/)
- [Reverse a payment](https://developer.zuora.com/api-references/api/operation/POST_ReversePayment/)
- [Reconcile a refund](https://developer.zuora.com/api-references/api/operation/POST_ReconcileRefund/)
name: Payment Gateway Reconciliation
- description: |
A Payment Method Snapshot is a copy of the particular Payment Method used in a transaction. If the Payment Method is deleted, the Snapshot continues to retain the data used in each of the past transactions.
As such, the Snapshot helps with display of historical transactions, integrations to external systems, and reporting.
name: Payment Method Snapshots
- description: |
The PaymentMethodTransactionLog object contains payment method transaction log data.
You can use the [CRUD: Retrieve a payment method transaction log](https://developer.zuora.com/v1-api-reference/api/operation/Object_GETPaymentMethodTransactionLog/) operation to export such data.
name: Payment Method Transaction Logs
- description: |
Payment methods represents payment method details associated with a customer account.
name: Payment Methods
- description: |
Zuora Payment Method Updater (PMU) enables merchants to automatically incorporate changes made to a customer's credit cards. For more information about Zuora PMU, see Payment Method Updater.
name: Payment Method Updater
- description: |
Use payment runs to collect payments using electronic payment methods, for example, credit cards and ACH.
For more information about payment runs, see Payment Runs.
name: Payment Runs
- description: |
Payment profiles enable payment flexibility for subscribers by allowing payment methods to be associated with specific subscriptions.
To learn more about the configuration and usage of Payment Profiles, see Payment Profiles.
name: Payment Profiles
- description: |
Use payment schedules to split invoice or account balances into several installments and automatically process payments for the installments.
For more information about payment schedules, see Payment Schedules.
name: Payment Schedules
- description: |
Use payment transaction logs to export logs of all transactions from Zuora to the Gateway for Payments.
name: Payment Transaction Logs
- description: |
The Delayed Capture feature allows you to authorize the availability of funds for a transaction but delay the capture of funds until a later time.
You can use the [Create authorization](https://developer.zuora.com/api-references/api/operation/POST_CreateAuthorization/) operation to authorize a payment amount before capturing the payment.
Subsequently, you can use [Create a payment](https://developer.zuora.com/api-references/api/operation/POST_CreatePayment) or [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order/) to capture the authorized funds, or use [Cancel authorization](https://developer.zuora.com/api-references/api/operation/POST_CancelAuthorization) to cancel the authorization.
name: Payment Authorization
- description: |
Use payments to process payments, for example, automate recurring payments, manage overpayments, and create refunds.
For more information about payments, see Payments.
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.
name: Prepaid with Drawdown
- description: |
**Note** - The APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead.
For more information, see our latest Commerce API.
Use product charge definitions to define the attributes that can determine
the charge behavior, such as billing attributes, pricing attributes, taxation
attributes, or accounting attributes.\n\nThe Product Charge Definition object
is in the **Early Adopter** phase. We are actively soliciting feedback from
a small set of early adopters before releasing it as generally available. If
you are interested, please reach out to your CSM.
name: Product Charge Definitions
- description: |
**Note** - The APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead.
For more information, see our latest Commerce API.
Use product rate plan definitions to reuse charges in different product
rate plans. The Product Rate Plan Definition object is in the **Early Adopter**
phase. We are actively soliciting feedback from a small set of early adopters
before releasing it as generally available. If you are interested, please reach
out to your CSM.
name: Product Rate Plan Definitions
- description: |
**Note** - The APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead.
For more information, see our latest Commerce API.
To manage product rate plan charge tiers, use the [Product Rate Plan
Charges](https://developer.zuora.com/api-references/api/tag/Product-Rate-Plan-Charges)
operations instead to update the corresponding product rate plan charge with all
the tiers.
name: Product Rate Plan Charge Tiers
- description: |
**Note** - The APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead.
For more information, see our latest Commerce API.
A product rate plan charge represents a charge model or a set of fees
associated with a product rate plan, which is the part of a product that your
customers subscribe to. Each product rate plan can have multiple product rate
plan charges.
Product rate plan charges can be of three types: one-time fees, recurring fees,
and usage fees. For example, the $50 activation fee for the Topaz product rate
plan is a one-time product rate plan charge.
name: Product Rate Plan Charges
- description: |
**Note** - The APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead.
For more information, see our latest Commerce API.
A product rate plan is the part of a product that your customers subscribe
to. Each product can have multiple product rate plans, and each product rate plan
can have multiple product rate plan charges, which are fees for products and their
product rate plans.
name: Product Rate Plans
- description: |
**Note** - The APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead.
For more information, see our latest Commerce API.
A product is an item or service that your company sells. In the subscription
economy, a product is generally a service that your customers subscribe to rather
than a physical item that they purchase one time. For example, customers subscribe
to a service that provides them a car when and where they need a car rather than
buying a car outright.
A Product object contains all of the items in a specific product, especially product
rate plans and product rate plan charges. Each Product object can have multiple
rate plans, which in turn can each have multiple rate plan charges. Each rate
plan charge can have multiple tiers. Taken together, all of these items create
a single product.
Customers subscribe to products that are in your product catalog. Product objects
collectively compose your product catalog. You create your product catalog by
creating products. As soon as you create your first product, you create your product
catalog.
name: Products
- description: |
A Ramp is a time container to associate with rate plan charges in your subscription. Inside the Ramp, you can further define a set of Ramp Intervals (time-based periods) where products or pricing can change. These periods are sub time containers to enable you to report out-of-the-box metrics based on Ramp Intervals.
**Notes**: You must have both the Ramps feature and Orders feature enabled for your tenant to use the Ramps operations.
For more information, see Ramps and Ramp Metrics.
name: Ramps
- description: |
A rate plan is part of a subscription or an amendment to a subscription, and it comes from a product rate plan. Like a product and its product rate plans, a subscription can have one or more rate plans.
Rate plans are sometimes called subscription rate plans. Rate plans that are part of an amendment are sometimes called amendment rate plans.
Rate plans represent a price or a collection of prices for a service you sell. An individual rate plan contains all charges specific to a particular subscription.
name: Rate Plans
- description: |
Zuora allows you to issue and track refunds on payments. Similar to external payments, users can enter external refunds to track refunds that have been performed outside of Zuora Payments (for example, by issuing a check).
In addition, you can make electronic refunds using our supported payment gateways, which will automatically refund money to the customer.
name: Refunds
- description: |
If you are an Order to Revenue user, you can use the Regenerate operations to regenerate transactions objects.
name: Regenerate
- description: |
The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature.
You can use the [Generate an RSA signature](https://developer.zuora.com/v1-api-reference/api/operation/POST_RSASignatures/) operation to generate the required digital signature and token for a Payment Pages 2.0 form, then use the [Decrypt an RSA signature](https://developer.zuora.com/v1-api-reference/api/operation/POST_DecryptRSASignatures/) operation to decrypt the signature to validate the signature and key."
name: RSA Signatures
- description: |
You can create billing document sequence sets through the REST API or the Zuora UI, allowing distinct numbering sequences for billing documents, payments, and refunds.
To create a billing document sequence set through the Zuora UI, see Create Billing Document Sequence Sets for more information.
name: Sequence Sets
- description: |
The Setting API provides a central API for managing settings in your Zuora tenant.
If you use Postman, you can import the Settings API endpoints as a collection into your Postman app and try out different requests to learn how the API works.
You can sign up for a free account on the [Postman website](https://identity.getpostman.com/signup) and download the app in case you do not use Postman yet.
name: Settings
- description: |
A light-weight API to sign up customers and subscribe.
You need to have the [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders/Orders_Harmonization) feature enabled to use this API.
name: Sign Up
- description: |
A subscription is a product or service that has recurring charges,
such as a monthly flat fee or charges based on usage. Subscriptions can also include
one-time charges, such as activation fees. Every subscription must be associated
with an account. At least one active account must exist before any subscriptions
can be created.
For more information, see Subscriptions.
name: Subscriptions
- description: |
An omnichannel subscription is a subscription originating from external and source systems, such as the Apple App Store, Google Play Store, and Roku Store.
To create, update, delete, or retrieve an omnichannel subscription, you must turn on the Omni-Channel Subscription feature. For more information, see Omni-Channel Subscription.
name: Omnichannel Subscriptions
- description: |
The change histories of single version subscriptions.
**Note**: To access the change histories, you must turn on the following features:
- Orders
- Single Version Subscription
name: Subscription Change History
- description: |
A summary journal entry is a summary of Zuora transaction amounts organized by accounting code and general ledger segments. A segment adds more reporting granularity through business dimensions, such as country or product.
For more information, see Summary Journal Entries Introduction
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.
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.
Changes that you make with this object affect the product charges in your product catalog, but not the charges in existing subscriptions.
name: Taxation Items
- description: |
Consumption of a billable service or resource (such as database storage space or bundles of emails sent) provides the basis for some charge models - simple usage, tiered pricing, or volume pricing.
To make this work, usage must be tracked in the system and usage charges must be calculated and invoiced.
Usage is always billed in arrears - for example, you might bill customers in February for their January usage. Usage can be billed on a recurring monthly, quarterly, semi-annual, or annual basis.
For more information about working with usage data, see Usage.
name: Usage
- description: |
A workflow is a sequence of tasks that are performed based on predefined logic. A workflow improves efficiency and reduces errors by automating a series of complex tasks that otherwise need to be performed manually and repetitively.
For more information, see Workflow.
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.
The APIs in this section are legacy APIs. Zuora recommends using the newer, faster APIs for managing products and catalogs more efficiently instead. For more information, see our latest Commerce API.
name: Zuora Revenue Integration
paths:
/test-environments:
get:
tags:
- Test Environments
summary: List all test environments
operationId: getAllTestEnvironments
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
responses:
'200':
description: Successfully retrieved a list of Test Environment responses
content:
application/json:
schema:
$ref: '#/components/schemas/TestEnvironmentArrayResponse'
'400':
description: Bad request
content: {}
'500':
description: Internal Error
content: {}
description: |
Use this operation to retrieves a list of all Test Environments.
It returns an ArrayResponse containing TestEnvironmentResponse objects,
representing the available Test Environments in the system.
### User Access Permission
You must be assigned the **Refresh Central Sandbox** permission to run
this operation.
/test-environments/{id}:
get:
tags:
- Test Environments
summary: Retrieve a test environment response
operationId: getTestEnvironment
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- description: Test Environment ID
in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: Successfully retrieved Test Environment response
content:
application/json:
schema:
$ref: '#/components/schemas/TestEnvironmentResponse'
'404':
description: The resource you were trying to reach is not found
content: {}
'500':
description: Internal Error
content: {}
description: |
Use this operation to retrieves a specific Test Environment by its unique identifier.
It returns a TestEnvironmentResponse object if the environment is found. If the specified
Test Environment does not exist, it returns a 404 error.
### User Access Permission
You must be assigned the **Refresh Central Sandbox** permission to run
this operation.
/test-environments/{id}/jobs:
post:
tags:
- Test Environment Jobs
summary: Create a test environment job
operationId: createTestEnvironmentJob
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- description: Test Environment ID
in: path
name: id
required: true
schema:
type: string
requestBody:
description: jobRequest
content:
application/json:
schema:
$ref: '#/components/schemas/JobRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/JobResponse'
'201':
description: Successfully created a new Test Environment job
content:
application/json:
schema:
$ref: '#/components/schemas/JobResponse'
'400':
description: Bad request
content:
application/json:
schema:
type: object
'403':
description: Only one refresh can be performed during a set period
content: {}
'500':
description: Internal Error
content: {}
x-codegen-request-body-name: jobRequest
description: |
Use this operation to create a new job for a specific Test Environment.
It handles HTTP POST requests to the /test-environments/{id}/jobs endpoint,
accepting a JobRequest object in the request body. Upon successful creation,
it returns a JobResponse object and sets the Location header to the polling
URL for the created job.
### User Access Permission
You must be assigned the **Refresh Central Sandbox** permission to run this operation.
get:
tags:
- Test Environment Jobs
summary: List all jobs of a test environment
operationId: getAllJobsOfTestEnvironment
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- description: Test Environment ID
in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: Successfully retrieved a list of Test Environment job responses
content:
application/json:
schema:
$ref: '#/components/schemas/JobArrayResponse'
'400':
description: Bad request
content:
application/json:
schema:
type: object
'500':
description: Internal Error
content: {}
description: |
Use this operation to retrieve a list of job responses associated
with a specific Test Environment. It handles HTTP GET requests to
the /test-environments/{id}/jobs endpoint and returns an ArrayResponse
containing JobResponse objects. This method is documented in Swagger,
including possible responses for successful retrieval and bad requests.
### User Access Permission
You must be assigned the **Refresh Central Sandbox**
permission to run this operation.
/test-environments/{id}/jobs/{jobId}:
get:
tags:
- Test Environment Jobs
summary: Retrieve a job of a test environment
operationId: getJobOfTestEnvironment
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- description: Test Environment ID
in: path
name: id
required: true
schema:
type: string
- description: Test Environment Job ID
in: path
name: jobId
required: true
schema:
type: string
responses:
'200':
description: Successfully retrieved a Test Environment job response
content:
application/json:
schema:
$ref: '#/components/schemas/JobResponse'
'404':
description: The resource you were trying to reach was not found
content: {}
'500':
description: Internal Error
content: {}
description: |
Use this operation to retrieve a specific job associated
with a Test Environment by its unique job ID. It handles
HTTP GET requests to the /test-environments/{id}/jobs/{jobId}
endpoint and returns a JobResponse object if the job is found.
If the specified job does not exist, it returns a 404 error.
### User Access Permission
You must be assigned the **Refresh Central Sandbox** permission to run this operation.
/test-environments/{id}/jobs/{jobId}/actions:
post:
tags:
- Test Environment Jobs
summary: Perform an action on a test environment job
operationId: performActionOfJob
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- description: Test Environment ID
in: path
name: id
required: true
schema:
type: string
- description: Test Environment Job ID
in: path
name: jobId
required: true
schema:
type: string
requestBody:
description: jobActionRequest
content:
application/json:
schema:
$ref: '#/components/schemas/JobActionRequest'
required: true
responses:
'200':
description: Successfully submitted Test Environment job action
content:
application/json:
schema:
$ref: '#/components/schemas/JobResponse'
'400':
description: Bad request
content: {}
'404':
description: The resource you were trying to reach is not found
content: {}
'500':
description: Internal Error
content: {}
x-codegen-request-body-name: jobActionRequest
description: |
Use this operation to perform a specified action
on a Test Environment job. It handles HTTP POST
requests to the /test-environments/{id}/jobs/{jobId}/actions
endpoint, accepting a JobActionRequest object in the
request body. Upon successful execution, it returns a
JobResponse object reflecting the updated job state.
### User Access Permission
You must be assigned the **Refresh Central Sandbox** permission to run this operation.
/test-environments/{id}/notifications:
post:
tags:
- Test Environment Notifications
summary: Create a test environment notification
operationId: createTestEnvironmentNotification
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- description: Test Environment ID
in: path
name: id
required: true
schema:
type: string
requestBody:
description: notificationRequest
content:
application/json:
schema:
$ref: '#/components/schemas/TestEnvironmentNotificationRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TestEnvironmentNotificationResponse'
'201':
description: Successfully created a new Test Environment notification
content:
application/json:
schema:
$ref: '#/components/schemas/TestEnvironmentNotificationResponse'
'400':
description: Bad request
content:
application/json:
schema:
type: object
'500':
description: Internal Error
content: {}
x-codegen-request-body-name: notificationRequest
description: |
Use this operation to create a new notification
for a specific Test Environment. It handles HTTP
POST requests to the /test-environments/{id}/notifications
endpoint, accepting a TestEnvironmentNotificationRequest
object in the request body. Upon successful creation,
it returns a TestEnvironmentNotificationResponse object
and sets the Location header to the URL of the created
notification.
### User Access Permission
You must be assigned the **Refresh Central Sandbox** permission to run this operation.
get:
tags:
- Test Environment Notifications
summary: List all email notifications of a test environment
operationId: getAllEmailNotificationOfTestEnv
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- description: Test Environment ID
in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: Successfully fetched all notifications
content:
application/json:
schema:
$ref: '#/components/schemas/TestEnvironmentNotificationArrayResponse'
'404':
description: The resource you were trying to reach was not found
content: {}
'500':
description: Internal Error
content: {}
description: |
Use this operation to retrieve all notifications associated
with a specific Test Environment. It handles HTTP GET
requests to the /test-environments/{id}/notifications
endpoint and returns an ArrayResponse containing
TestEnvironmentNotificationResponse objects.
### User Access Permission
You must be assigned the **Refresh Central Sandbox** permission to run this operation.
/test-environments/{id}/notifications/{notificationId}:
get:
tags:
- Test Environment Notifications
summary: Retrieve a notification response of a test environment
operationId: getTestEnvironmentNotification
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- description: Test Environment ID
in: path
name: id
required: true
schema:
type: string
- description: Test Environment Notification ID
in: path
name: notificationId
required: true
schema:
type: string
responses:
'200':
description: Successfully retrieved a Test Environment notification response
content:
application/json:
schema:
$ref: '#/components/schemas/TestEnvironmentNotificationResponse'
'404':
description: The resource you were trying to reach was not found
content: {}
'500':
description: Internal Error
content: {}
description: |
Use this operation to retrieve a specific notification associated
with a Test Environment by its unique notification ID. It handles
HTTP GET requests to the /test-environments/{id}/notifications/{notificationId}
endpoint and returns a TestEnvironmentNotificationResponse object
if the notification is found. If the specified notification does
not exist, it returns a 404 error.
### User Access Permission
You must be assigned the **Refresh Central Sandbox** permission to run this operation.
patch:
tags:
- Test Environment Notifications
summary: Update a test environment notification
operationId: updateTestEnvironmentNotification
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- description: Test Environment ID
in: path
name: id
required: true
schema:
type: string
- description: Test Environment Notification ID
in: path
name: notificationId
required: true
schema:
type: string
requestBody:
description: notificationRequest
content:
application/json:
schema:
$ref: '#/components/schemas/TestEnvironmentNotificationRequest'
required: true
responses:
'200':
description: Successfully updated a Test Environment notification
content:
application/json:
schema:
$ref: '#/components/schemas/TestEnvironmentNotificationResponse'
'400':
description: Bad request
content:
application/json:
schema:
type: object
'500':
description: Internal Error
content: {}
x-codegen-request-body-name: notificationRequest
description: |
Use this operation to update an existing notification
for a specific Test Environment. It handles HTTP PATCH
requests to the /test-environments/{id}/notifications/{notificationId}
endpoint, accepting a TestEnvironmentNotificationRequest
object in the request body. Upon successful update, it
returns a TestEnvironmentNotificationResponse object.
### User Access Permission
You must be assigned the **Refresh Central Sandbox** permission to run this operation.
delete:
tags:
- Test Environment Notifications
summary: Delete a notification of a test environment
operationId: deleteTestEnvironmentNotification
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- description: Test Environment ID
in: path
name: id
required: true
schema:
type: string
- description: Test Environment Notification ID
in: path
name: notificationId
required: true
schema:
type: string
responses:
'200':
description: Successfully deleted a notification
content:
application/json:
schema:
$ref: '#/components/schemas/TestEnvironmentNotificationResponse'
'404':
description: The resource you were trying to reach is not found
content: {}
'500':
description: Internal Error
content: {}
description: |
Use this operation to delete a specific notification associated
with a Test Environment. It handles HTTP DELETE requests to the
/test-environments/{id}/notifications/{notificationId} endpoint
and returns a TestEnvironmentNotificationResponse object for the
deleted notification. If the specified notification does not exist,
it returns a 404 error.
### User Access Permission
You must be assigned the **Refresh Central Sandbox** permission to run this operation.
/oauth/token:
post:
security: []
description: |
Creates a bearer token that enables an OAuth client to authenticate with the Zuora REST API. The OAuth client must have been created using the Zuora UI. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/) for more information.
**Note:** When using this operation, do not set any authentication headers such as `Authorization`, `apiAccessKeyId`, or `apiSecretAccessKey`.
You should not use this operation to generate a large number of bearer tokens in a short period of time; each token should be used until it expires. If you receive a 429 Too Many Requests response when using this operation, reduce the frequency of requests. This endpoint is rate limited by IP address.
For the rate limit information of authentication, see [Rate and concurrent request limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/).
operationId: createToken
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- name: Zuora-Entity-Ids
in: header
required: false
description: |
An entity ID if you have Multi-entity enabled.
The value must be a 36-character UUID that contains hyphens(`-`).
If your entity ID is not a valid UUID, convert it to a valid UUID before specifying this parameter.
schema:
type: string
format: uuid
example: 11e643f4-a3ee-8bad-b061-0025904c756d
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
client_id:
description: |
The Client ID of the OAuth client.
maxLength: 36
minLength: 36
type: string
client_secret:
description: |
The Client Secret that was displayed when the OAuth client was created.
maxLength: 42
type: string
grant_type:
description: |
The OAuth grant type that will be used to generate the token. The value of this parameter must be `client_credentials`.
enum:
- client_credentials
type: string
required:
- client_id
- client_secret
- grant_type
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
access_token: c652cbc0ea384b9f81856a93a2a74538
expires_in: 3599
jti: c652cbc0ea384b9f81856a93a2a74539
scope: user.7c4d5433dc234c369a01b9719ecd059f entity.1a2b7a37-3e7d-4cb3-b0e2-883de9e766cc entity.c92ed977-510c-4c48-9b51-8d5e848671e9 service.echo.read tenant.19
token_type: bearer
schema:
$ref: '#/components/schemas/tokenResponse'
description: OK
headers:
X-RateLimit-Limit-minute:
description: |
The rate limit of this operation, in requests per minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: integer
X-RateLimit-Remaining-minute:
description: |
The number of requests that you may make in the next minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: integer
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
'429':
description: Too Many Requests
headers:
X-RateLimit-Limit-minute:
description: |
The rate limit of this operation, in requests per minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: integer
X-RateLimit-Remaining-minute:
description: |
The number of requests that you may make in the next minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: integer
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Create an OAuth token
tags:
- OAuth
x-code-samples:
- label: Curl
lang: curl
source: |
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=b64e42ba-7e1a-4bc6-9146-5e1b420306b5" --data-urlencode "client_secret=dOFENLWU193EEoEsWjPZrcjLKVr5OrN1HC9Kqg" -d "grant_type=client_credentials" "https://rest.zuora.com/oauth/token"
/v1/object/product:
post:
description: ''
operationId: Object_POSTProduct
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyCreateProduct'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
Id: 2c93808457d787030157e03246ae5129
Success: true
schema:
$ref: '#/components/schemas/ProxyCreateOrModifyResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'400':
content:
application/json:
examples:
response:
value:
Errors:
- Code: INVALID_VALUE
Message: The account number 123xProxy is invalid.
Success: false
schema:
$ref: '#/components/schemas/ProxyBadRequestResponse'
description: ''
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Create a product'
tags:
- Products
/v1/object/product/{id}:
get:
description: Retrieve a specific product.
operationId: Object_GETProduct
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
- description: Object fields to return
in: query
name: fields
required: false
schema:
type: string
- description: Object id
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
CreatedById: 2c93808457d787030157e02e62af2097
CreatedDate: '2016-10-20T05:42:05.000+02:00'
Description: Create product via API_new
EffectiveEndDate: '2066-10-20'
EffectiveStartDate: '1966-10-20'
Id: 2c93808457d787030157e02e7be22210
Name: P_1476934925293_new
SKU: API-SKU1476934925293
UpdatedById: 2c93808457d787030157e02e62af2097
UpdatedDate: '2016-10-20T05:42:05.000+02:00'
schema:
$ref: '#/components/schemas/ProxyGetProduct'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'404':
content:
application/json:
examples:
response:
value:
done: true
records: {}
size: 0
schema:
$ref: '#/components/schemas/ProxyNoDataResponse'
description: ''
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Retrieve a product'
tags:
- Products
put:
description: Updates a Product object.
operationId: Object_PUTProduct
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
- description: Object id
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyModifyProduct'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
Id: 2c93808457d787030157e02e7be22210
Success: true
schema:
$ref: '#/components/schemas/ProxyCreateOrModifyResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Update a product'
tags:
- Products
delete:
description: Deletes a specific product.
operationId: Object_DELETEProduct
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- description: Object id
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
id: 2c93808457d787030157e02e7a22220e
success: true
schema:
$ref: '#/components/schemas/ProxyDeleteResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Delete a product'
tags:
- Products
/v1/catalog/products:
get:
description: |
Retrieves the entire product catalog, including all products, features, and their corresponding product rate plans, charges. Products are returned in reverse chronological order on the `UpdatedDate` field.
For each product, this operation returns a maximum of 300 product rate plans in the response. Across the returned product rate plans, up to 300 product rate plan charges can be returned for each product.
operationId: GET_Catalog
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_REQUEST_page'
- $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_catalog'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
products:
- category: Base Products
description: ''
effectiveEndDate: '2020-01-01'
effectiveStartDate: '2017-01-01'
id: 8a8082c45aa81b51015ad5a2d07d0e89
name: ABC
productNumber: PC-00000011
productRatePlans: https://rest.zuora.com/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan
sku: SKU-00000987
success: true
schema:
$ref: '#/components/schemas/GETCatalogType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List all products
tags:
- Catalog
/v1/catalog/products/{product-key}:
get:
description: |
Retrieves detailed information about a specific product, including information about its product rate plans and charges.
This operation returns a maximum of 300 product rate plans and 300 product rate plan charges across all product rate plans in the response.
operationId: GET_Product
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
The unique ID, SKU, or product number of the product that you want to retrieve. For example, 8a808255575bdae4015774e9602e16fe, SKU-00000987, or PC-00000006.
in: path
name: product-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
category: Base Products
description: ''
effectiveEndDate: '2020-01-01'
effectiveStartDate: '2017-01-01'
id: 8a8082c45aa81b51015ad5a2d07d0e89
name: ABC
productNumber: PC-00000006
productRatePlans: https://rest.zuora.com/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan
sku: SKU-00000987
success: true
schema:
$ref: '#/components/schemas/GETProductType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a product
tags:
- Catalog
/v1/catalog-groups:
post:
description: |
**Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
Creates a catalog group which groups a list of product rate plans.
operationId: POST_CreateCatalogGroup
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTCatalogGroupRequest'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
catalogGroupNumber: CG-00000001
description: some description
id: 4028e5ab7f1b600c017f1b7a5e8901d2
name: test
productRatePlans:
- description: null
effectiveEndDate: '2023-02-21'
effectiveStartDate: '2022-02-21'
grade: 1
id: 4028e5ab7f1b600c017f1b787d5d01cf
name: '222'
status: Active
type: Grading
schema:
$ref: '#/components/schemas/CatalogGroupResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Create a catalog group
tags:
- Catalog Groups
get:
description: |
**Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
Retrieves basic information about all catalog groups.
operationId: GET_ListAllCatalogGroups
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
- $ref: '#/components/parameters/GLOBAL_REQUEST_page'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
catalogGroups:
- catalogGroupNumber: CG-00000001
description: some description
id: 4028e5ab7f1b600c017f1b7a5e8901d2
name: test
productRatePlans:
- description: null
effectiveEndDate: '2023-02-21'
effectiveStartDate: '2022-02-21'
grade: 1
id: 4028e5ab7f1b600c017f1b787d5d01cf
name: '222'
status: Active
type: Grading
nextPage: false
schema:
$ref: '#/components/schemas/ListAllCatalogGroupsResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List all catalog groups
tags:
- Catalog Groups
/v1/catalog-groups/{catalog-group-key}:
get:
description: |
**Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
Retrieves basic information about a catalog group.
operationId: GET_RetrieveCatalogGroup
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
The unique number or ID of the catalog group to be retrieved.
in: path
name: catalog-group-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
catalogGroupNumber: CG-00000001
description: some description
id: 4028e5ab7f1b600c017f1b7a5e8901d2
name: test
productRatePlans:
- description: null
effectiveEndDate: '2023-02-21'
effectiveStartDate: '2022-02-21'
grade: 1
id: 4028e5ab7f1b600c017f1b787d5d01cf
name: '222'
status: Active
type: Grading
schema:
$ref: '#/components/schemas/CatalogGroupResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a catalog group
tags:
- Catalog Groups
put:
description: |
**Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
Updates a catalog group by its unique number or ID.
### Notes
- It is best practice to only specify the fields that you want to change in the request body.
- If you specify an empty value for a field in the request body, the corresponding field in the catalog group is emptied.
- The catalog group type cannot be changed.
operationId: PUT_UpdateCatalogGroup
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
The unique number or ID of the catalog group to be updated.
in: path
name: catalog-group-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTCatalogGroup'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
catalogGroupNumber: CG-00000001
description: some description
id: 4028e5ab7f1b600c017f1b7a5e8901d2
name: test
productRatePlans:
- description: null
effectiveEndDate: '2023-02-21'
effectiveStartDate: '2022-02-21'
grade: 1
id: 4028e5ab7f1b600c017f1b787d5d01cf
name: '222'
status: Active
type: Grading
schema:
$ref: '#/components/schemas/CatalogGroupResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update a catalog group
tags:
- Catalog Groups
delete:
description: |
**Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
Deletes a catalog group.
operationId: DELETE_CatalogGroup
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
The unique number or ID of the catalog group to be deleted.
in: path
name: catalog-group-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
success: 'true'
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Delete a catalog group
tags:
- Catalog Groups
/v1/products/{product-key}/product-rate-plans:
get:
description: |
Retrieves information about all product rate plans of a specific product.
operationId: GET_ProductRatePlans
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_REQUEST_page'
- $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
- description: |
The unique ID or SKU of a product. For example, 2c92c0f96487e16a016487f663c71a61 or SKU-00000987.
in: path
name: product-key
required: true
schema:
type: string
- description: |
Specifies whether to include the product charge definitions of this rate plan in the response.
**Note**: This parameter is applicable only if the Attribute Based Pricing feature is enabled. To access this feature, submit a request at Zuora Global Support.
in: query
name: show-charge-definitions
required: false
schema:
type: boolean
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
productRatePlans:
- description: ''
effectiveEndDate: '2020-07-31'
effectiveStartDate: '2016-07-01'
grade: 3
id: 40289f466464127601646473d6f7000f
name: New Rate Plan
productRatePlanCharges:
- applyDiscountTo: null
billingDay: DefaultFromCustomer
billingPeriod: Month
billingPeriodAlignment: AlignToCharge
billingTiming: IN_ADVANCE
defaultQuantity: null
description: ''
discountClass: null
discountLevel: null
endDateCondition: Subscription_End
financeInformation:
deferredRevenueAccountingCode: ''
deferredRevenueAccountingCodeType: null
recognizedRevenueAccountingCode: ''
recognizedRevenueAccountingCodeType: null
id: 40289f4664641276016464740dd0001c
listPriceBase: Per_Billing_Period
model: FlatFee
name: New Component
numberOfPeriods: null
overageCalculationOption: null
overageUnusedUnitsCreditOption: null
priceChangeOption: null
priceIncreasePercentage: null
pricing:
- currency: USD
discountAmount: null
discountPercentage: null
includedUnits: null
overagePrice: null
price: 100
tiers: null
pricingSummary:
- USD100
productChargeDefinitions: https://rest.zuora.com/v1/product-charge-definitions?charge=8a80808e8aaf3b0a018aaf3f2beb022b&rateplan=8a80808e8aaf3b0a018aaf3ed4cf021e
productDiscountApplyDetails: []
productRatePlanChargeNumber: PRPC-00000001
revRecCode: ''
revRecTriggerCondition: ContractEffectiveDate
revenueRecognitionRuleName: Recognize upon invoicing
smoothingModel: null
specificBillingPeriod: null
specificListPriceBase: null
taxCode: ''
taxMode: null
taxable: false
triggerEvent: ContractEffective
type: Recurring
unusedIncludedUnitPrice: null
uom: null
upToPeriods: null
upToPeriodsType: null
usageRecordRatingOption: null
useDiscountSpecificAccountingCode: null
useTenantDefaultForPriceChange: null
productRatePlanNumber: PRP-00000001
status: Active
success: true
schema:
$ref: '#/components/schemas/GETProductRatePlansResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List all product rate plans of a product
tags:
- Product Rate Plans
/v1/product-rate-plans/{id}:
get:
description: |
Retrieves a product rate plan by its ID.
operationId: GET_ProductRatePlan
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
The ID, external ID, or the natural key of the product rate plan to be retrieved. For example, `402888e67f8b3a68017f8bbb2a06062d`, `Apple0001`, or `PRP-00000008`.
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
description: ''
effectiveEndDate: '2032-02-01'
effectiveStartDate: '2012-02-01'
externalIdSourceSystem: apple
externallyManagedPlanIds:
- Apple0001
- Apple0002
- Google0003
grade: 3
id: 402888e67f8b3a68017f8bbb2a06062d
name: New Rate Plan Change
productRatePlanNumber: PRP-00000008
status: Active
success: true
schema:
$ref: '#/components/schemas/GETProductRatePlanWithExternalIdResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a product rate plan by ID
tags:
- Product Rate Plans
/v1/product-rate-plans/external-id/{id}:
get:
description: |
Retrieves information about one or multiple product rate plans by external ID.
operationId: GET_ProductRatePlansByExternalID
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
The external ID of the product rate plan to be retrieved. For example, `Apple0001`.
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
productRatePlans:
- id: 2c989020823f450c01823fef40421eb6
status: Active
name: My rate plan - Monthly Basic
description: ''
effectiveStartDate: '2024-01-01'
effectiveEndDate: '2026-01-01'
externalIdSourceSystem: apple
externallyManagedPlanIds:
- zuora-us-monthly-basic
productRatePlanNumber: 1001
schema:
$ref: '#/components/schemas/GETProductRatePlanWithExternalIdMultiResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List product rate plans by external ID
tags:
- Product Rate Plans
/v1/object/product-rate-plan:
post:
description: |
Retrieves a product rate plan.
operationId: Object_POSTProductRatePlan
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyCreateProductRatePlan'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
Id: 2c93808457d787030157e0324735512b
Success: true
schema:
$ref: '#/components/schemas/ProxyCreateOrModifyResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'400':
content:
application/json:
examples:
response:
value:
Errors:
- Code: INVALID_VALUE
Message: The account number 123xProxy is invalid.
Success: false
schema:
$ref: '#/components/schemas/ProxyBadRequestResponse'
description: ''
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Create a product rate plan'
tags:
- Product Rate Plans
/v1/object/product-rate-plan/{id}:
get:
description: |
Retrieves a product rate plan.
operationId: Object_GETProductRatePlan
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
- description: Object fields to return
in: query
name: fields
required: false
schema:
type: string
- description: Object id
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
CreatedById: 2c93808457d787030157e02d84c116d5
CreatedDate: '2016-10-20T05:41:09.000+02:00'
Description: Test create product rateplan via API
EffectiveEndDate: '2066-10-20'
EffectiveStartDate: '1966-10-20'
Grade: 3
Id: 2c93808457d787030157e02da0d91852
Name: ProductRatePlan1476934869186_new
ProductId: 2c93808457d787030157e02da0231850
UpdatedById: 2c93808457d787030157e02d84c116d5
UpdatedDate: '2016-10-20T05:41:09.000+02:00'
schema:
$ref: '#/components/schemas/ProxyGetProductRatePlan'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'404':
content:
application/json:
examples:
response:
value:
done: true
records: {}
size: 0
schema:
$ref: '#/components/schemas/ProxyNoDataResponse'
description: ''
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Retrieve a product rate plan'
tags:
- Product Rate Plans
put:
description: |
Updates a product rate plan.
operationId: Object_PUTProductRatePlan
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
- description: Object id
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyModifyProductRatePlan'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
Id: 2c93808457d787030157e02da0d91852
Success: true
schema:
$ref: '#/components/schemas/ProxyCreateOrModifyResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Update a product rate plan'
tags:
- Product Rate Plans
delete:
description: |
Deletes a product rate plan.
operationId: Object_DELETEProductRatePlan
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- description: Object id
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
id: 2c93808457d787030157e02d9dde184f
success: true
schema:
$ref: '#/components/schemas/ProxyDeleteResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Delete a product rate plan'
tags:
- Product Rate Plans
/v1/product-rateplan-definitions:
post:
description: |
Creates a product rate plan definition to use a charge in a product rate plan.
In the request, you must specify either the unique ID or number of both the charge and the product rate plan to add the specified charge to a specific rate plan.
**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase.
operationId: POST_CreateProductRatePlanDefinition
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTRatePlanDefinitionRequest'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
id: 2c9890f78aba5c16018ababa00120019
success: true
schema:
$ref: '#/components/schemas/POSTRatePlanDefinitionResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Create a product rate plan definition
tags:
- Product Rate Plan Definitions
get:
description: |
Retrieves basic information about the product rate plan definitions for a product rate plan.
**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase.
operationId: GET_RetrieveProductRatePlanDefinitions
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- description: |
The unique number or ID of the charge for which the product rate plan definitions are to be retrieved.
in: query
name: charge
required: false
schema:
type: string
- description: |
The unique number or ID of the product rate plan for which the product rate plan definitions are to be retrieved.
in: query
name: rateplan
required: false
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
productRatePlanDefinitions:
- id: 2c9890f78b212d76018b218993c9005c
productRatePlanChargeId: 2c9890f78aba5c16018ababa00120019
productRatePlanChargeName: New Component
productRatePlanChargeNumber: PRPC-NEW-00000175
productRatePlanId: 2c9890678b1ca909018b1caea5c30000
productRatePlanName: New Rate Plan2
productRatePlanNumber: PRP-NEW-00000353
- id: 2c9890f78b212d76018b21742683005a
productRatePlanChargeId: 2c9890f78b212d76018b2174263c004a
productRatePlanChargeName: API_Usage_Tiered-multi
productRatePlanChargeNumber: PRPC-NEW-00000246
productRatePlanId: 2c9890678b1ca909018b1caea5c30000
productRatePlanName: New Rate Plan2
productRatePlanNumber: PRP-NEW-00000353
success: true
schema:
$ref: '#/components/schemas/GETProductRatePlanDefinitionsResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List product rate plan definitions
tags:
- Product Rate Plan Definitions
/v1/product-rateplan-definitions/{product-rateplan-definition-key}:
get:
description: |
Retrieves basic information about a product rate plan definition.
**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase.
operationId: GET_RetrieveProductRatePlanDefinition
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- description: |
The unique ID of the product rate plan definition to be retrieved.
in: path
name: product-rateplan-definition-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
id: 2c9890f78b212d76018b21937228005d
productRatePlanChargeId: 2c9890e489f227bd0189f22f3482001f
productRatePlanChargeName: Per Unit
productRatePlanChargeNumber: null
productRatePlanId: 2c9890678b1ca909018b1caea5c30000
productRatePlanName: New Rate Plan2
productRatePlanNumber: PRP-NEW-00000353
success: true
schema:
$ref: '#/components/schemas/GETProductRatePlanDefinitionResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a product rate plan definition
tags:
- Product Rate Plan Definitions
delete:
description: |
Deletes a product rate plan definition.
**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase.
operationId: DELETE_ProductRatePlanDefnition
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- description: |
The unique ID of the product rate plan definition to be deleted.
in: path
name: product-rateplan-definition-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Delete a product rate plan definition
tags:
- Product Rate Plan Definitions
/v1/product-rate-plan-charges/{product-rate-plan-charge-key}:
get:
description: |
Retrieves basic information about a product rate plan charge.
operationId: GET_RetrieveProductRatePlanCharge
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- description: |
The unique number or ID of the product rate plan charge to be retrieved.
in: path
name: product-rate-plan-charge-key
required: true
schema:
type: string
- description: |
Specifies whether to include the product charge definitions of this charge in the response.
**Note**: This parameter is applicable only if the Attribute-based Pricing feature is enabled. The Attribute-based Pricing feature in the **Early Adopter** phase.
We are actively soliciting feedback from a small set of early adopters. If you are interested, please reach out to your CSM.
in: query
name: show-charge-definitions
required: false
schema:
type: boolean
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
id: edca018c566983fa11f6d38381b10000
name: Attribute based pricing charge with formula
type: Recurring
model: FlatFee
uom: null
pricingSummary:
- USD60
pricing:
- currency: USD
price: 60
tiers: null
includedUnits: null
overagePrice: null
discountPercentage: null
discountAmount: null
defaultQuantity: null
applyDiscountTo: null
discountLevel: null
discountClass: null
applyToBillingPeriodPartially: false
productDiscountApplyDetails: []
endDateCondition: Subscription_End
upToPeriods: null
upToPeriodsType: null
billingDay: DefaultFromCustomer
listPriceBase: Per_Billing_Period
specificListPriceBase: null
billingTiming: IN_ADVANCE
ratingGroup: null
billingPeriod: Month
billingPeriodAlignment: AlignToCharge
specificBillingPeriod: null
smoothingModel: null
numberOfPeriods: null
overageCalculationOption: null
overageUnusedUnitsCreditOption: null
unusedIncludedUnitPrice: null
usageRecordRatingOption: null
priceChangeOption: null
priceIncreasePercentage: null
useTenantDefaultForPriceChange: true
taxable: false
taxCode: ''
taxMode: null
isPrepaid: false
prepaidOperationType: null
prepaidUom: null
prepaidQuantity: null
prepaidTotalQuantity: null
validityPeriodType: SUBSCRIPTION_TERM
drawdownRate: null
drawdownUom: null
creditOption: TimeBased
isRollover: false
rolloverPeriods: 0
rolloverPeriodLength: 0
rolloverApply: ApplyLast
triggerEvent: ContractEffective
description: ''
revRecCode: null
revRecTriggerCondition: null
revenueRecognitionRuleName: Recognize upon invoicing
useDiscountSpecificAccountingCode: null
excludeItemBookingFromRevenueAccounting: false
excludeItemBillingFromRevenueAccounting: false
financeInformation:
deferredRevenueAccountingCode: ''
deferredRevenueAccountingCodeType: null
recognizedRevenueAccountingCode: ''
recognizedRevenueAccountingCodeType: null
accountsReceivableAccountingCode: Accounts Receivable
accountsReceivableAccountingCodeType: AccountsReceivable
contractAssetAccountingCode: null
contractAssetAccountingCodeType: null
contractLiabilityAccountingCode: null
contractLiabilityAccountingCodeType: null
adjustmentLiabilityAccountingCode: null
adjustmentLiabilityAccountingCodeType: null
unbilledReceivablesAccountingCode: null
unbilledReceivablesAccountingCodeType: null
adjustmentRevenueAccountingCode: null
adjustmentRevenueAccountingCodeType: null
contractRecognizedRevenueAccountingCode: null
contractRecognizedRevenueAccountingCodeType: null
deliverySchedule: null
isStackedDiscount: false
productRatePlanChargeNumber: null
formula: lookup("soldToRegion__c" = fieldLookup("subscription", "soldToRegion__c"))
productChargeDefinitions: https://rest-staging2.zuora.com/apps/v1/product-charge-definitions?charge=edca018c566983fa11f6d38381b10000
success: true
schema:
$ref: '#/components/schemas/GETProductRatePlanChargeResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: Retrieve a product rate plan charge
tags:
- Product Rate Plan Charges
/v1/object/product-rate-plan-charge:
post:
description: |
Creates a product rate plan charge for a specified rate plan charge.
Product rate plan charges can be of three types, one-time fees, recurring fees, and usage fees.
operationId: Object_POSTProductRatePlanCharge
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyCreateProductRatePlanCharge'
examples:
valid_per_specific_months:
summary: SpecificListPriceBase at upper bound example
value:
Name: Maximum Specific List Price Base Charge
Description: Charge with maximum specific list price base
ChargeModel: Flat Fee Pricing
ChargeType: Recurring
ProductRatePlanId: '{YourProductRatePlanId}'
BillCycleType: DefaultFromCustomer
BillingPeriod: Month
TriggerEvent: ContractEffective
ListPriceBase: Per Specific Months
SpecificListPriceBase: 120
ProductRatePlanChargeTierData:
ProductRatePlanChargeTier:
- Price: 99.99
UseDiscountSpecificAccountingCode: false
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
Id: 2c93808457d787030157e03197714910
Success: true
schema:
$ref: '#/components/schemas/ProxyCreateOrModifyResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Create a product rate plan charge'
tags:
- Product Rate Plan Charges
/v1/object/product-rate-plan-charge/{id}:
get:
description: Retrieves a specific product rate plan charge.
operationId: Object_GETProductRatePlanCharge
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
- description: Object fields to return
in: query
name: fields
required: false
schema:
type: string
- description: |
The unique ID of a product rate plan charge to be retrieved. For example, 2c93808457d787030157e031fcd34e19.
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
AccountingCode: name_1476935155610
BillCycleDay: 1
BillCycleType: DefaultFromCustomer
BillingPeriod: Month
BillingPeriodAlignment: AlignToCharge
BillingTiming: In Advance
ChargeModel: Flat Fee Pricing
ChargeType: Recurring
CreatedById: 2c93808457d787030157e031dd264c85
CreatedDate: '2016-10-20T05:45:55.000+02:00'
DefaultQuantity: 1
DeferredRevenueAccount: name_1476935155610
Description: Recurring Flat Fee Pricing
EndDateCondition: SubscriptionEnd
Id: 2c93808457d787030157e032002b4e21
IncludedUnits: 0
LegacyRevenueReporting: false
ListPriceBase: Per Billing Period
Name: Recurring_Flat Fee Pricing1476935155610
NumberOfPeriod: 1
OverageCalculationOption: EndOfSmoothingPeriod
OverageUnusedUnitsCreditOption: NoCredit
PriceChangeOption: NoChange
PriceIncreasePercentage: 0
ProductRatePlanId: 2c93808457d787030157e031ff054e1e
RecognizedRevenueAccount: name_1476935155610
RevenueRecognitionRuleName: Recognize upon invoicing
Taxable: false
TriggerEvent: ContractEffective
UpToPeriodsType: Billing Periods
UpdatedById: 2c93808457d787030157e031dd264c85
UpdatedDate: '2016-10-20T05:45:55.000+02:00'
UseTenantDefaultForPriceChange: true
Formula: ''
schema:
$ref: '#/components/schemas/ProxyGetProductRatePlanCharge'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'404':
content:
application/json:
examples:
response:
value:
done: true
records: {}
size: 0
schema:
$ref: '#/components/schemas/ProxyNoDataResponse'
description: ''
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Retrieve a product rate plan charge'
tags:
- Product Rate Plan Charges
put:
description: |
Updates the information about a product rate plan charge.
operationId: Object_PUTProductRatePlanCharge
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
- description: |
The unique ID of the product rate plan charge to be updated. For example, 2c93808457d787030157e031fcd34e19.
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyModifyProductRatePlanCharge'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
Id: 2c93808457d787030157e03197714910
Success: true
schema:
$ref: '#/components/schemas/ProxyCreateOrModifyResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'404':
content:
application/json:
examples:
response:
value:
done: true
records: {}
size: 0
schema:
$ref: '#/components/schemas/ProxyNoDataResponse'
description: ''
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Update a product rate plan charge'
tags:
- Product Rate Plan Charges
delete:
description: |
Deletes a product rate plan charge.
operationId: Object_DELETEProductRatePlanCharge
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- description: |
The unique ID of the product rate plan charge to be deleted. For example, 2c93808457d787030157e031fcd34e19.
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
id: 2c93808457d787030157e031fcd34e19
success: true
schema:
$ref: '#/components/schemas/ProxyDeleteResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Delete a product rate plan charge'
tags:
- Product Rate Plan Charges
/v1/product-charge-definitions:
post:
description: |
Creates a product charge definition for a charge. You can create as many product charge definitions as needed for one charge.
In the request, you must specify the unique ID or number of the charge for which this charge definition is to be created.
The ID or number of a product rate plan is optional.
**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase.
operationId: POST_CreateProductChargeDefinition
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTChargeDefinitionRequest'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
chargeDefinitionId: 8a90988c8b177a24018b17857411002a
chargeDefinitionNumber: CD-00002089
success: true
schema:
$ref: '#/components/schemas/POSTChargeDefinitionResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Create a product charge definition
tags:
- Product Charge Definitions
get:
description: |
Retrieves basic information about the product charge definitions.
**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase.
operationId: GET_RetrieveProductChargeDefinitions
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- description: |
The unique number or ID of the charge for which the product charge definitions are to be retrieved.
in: query
name: charge
required: false
schema:
type: string
- description: |
The unique number or ID of the product rate plan for which the product charge definitions are to be retrieved.
in: query
name: rateplan
required: false
schema:
type: string
- description: |
The flag that controls whether the response will merge the default charge definition fields for those fields that are not overridden.
in: query
name: hide-inherited-values
required: false
schema:
type: boolean
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
chargeDefinitions:
- applyDiscountTo: null
billingDay: DefaultFromCustomer
billingPeriod: Month
billingPeriodAlignment: AlignToCharge
billingTiming: IN_ADVANCE
chargeModel: FlatFee
defaultQuantity: 1
deliverySchedule: null
description: ''
discountClass: null
discountLevel: null
effectiveEndDate: '2023-10-13 09:00:00'
effectiveStartDate: '2022-10-07 09:00:00'
endDateCondition: Subscription_End
financeInformation:
accountsReceivableAccountingCode: null
accountsReceivableAccountingCodeType: null
deferredRevenueAccountingCode: ''
deferredRevenueAccountingCodeType: null
recognizedRevenueAccountingCode: ''
recognizedRevenueAccountingCodeType: null
isDefault: true
isStackedDiscount: false
listPriceBase: Per_Billing_Period
numberOfPeriods: null
overageCalculationOption: null
overageUnusedUnitsCreditOption: null
priceChangeOption: null
priceIncreasePercentage: null
prices:
- currency: EUR
price: 10
- currency: JPY
price: 20
- currency: USD
price: 25
productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004
productChargeDefinitionNumber: CD-00000201
productDiscountApplyDetails: []
productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004
productRatePlanChargeNumber: null
productRatePlanId: null
productRatePlanName: null
productRatePlanNumber: null
ratingGroup: null
revRecCode: null
revRecTriggerCondition: null
revenueRecognitionRuleName: Recognize upon invoicing
smoothingModel: null
specificBillingPeriod: null
specificListPriceBase: null
taxCode: ''
taxMode: null
taxable: false
term: null
termPeriodType: null
termType: null
triggerEvent: ContractEffective
uom: null
upToPeriods: null
upToPeriodsType: null
usageRecordRatingOption: null
useDiscountSpecificAccountingCode: null
useTenantDefaultForPriceChange: true
success: true
schema:
$ref: '#/components/schemas/GETProductChargeDefinitionsResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List product charge definitions
tags:
- Product Charge Definitions
/v1/product-charge-definitions/bulk:
post:
description: |
Bulk creates product charge definitions for a charge. You can create up to 1000 product charge definitions at a given time for a specific charge.
In the request, you must specify the unique ID or number of the charge for which this charge definition is to be created.
The ID or number of a product rate plan is optional.
**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase.
operationId: POST_CreateProductChargeDefinitionBulk
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTChargeDefinitionRequestBulk'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
summary:
successCount: 1
failureCount: 0
failures: []
results:
- chargeDefinitionId: 8a9084f99325571d01932a15d64a3a1b
chargeDefinitionNumber: CD-00052014
success: true
success: true
schema:
$ref: '#/components/schemas/POSTChargeDefinitionBulkResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Create product charge definitions
tags:
- Product Charge Definitions
put:
description: |
Bulk updates multiple product charge definitions.
**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase.
operationId: PUT_UpdateProductChargeDefinitionBulk
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTProductChargeDefinitionBulkRequest'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
chargeDefinitions:
- applyDiscountTo: null
billingDay: DefaultFromCustomer
billingPeriod: Month
billingPeriodAlignment: AlignToCharge
billingTiming: IN_ADVANCE
chargeModel: FlatFee
defaultQuantity: 1
deliverySchedule: null
description: ''
discountClass: null
discountLevel: null
endDateCondition: Subscription_End
financeInformation:
accountsReceivableAccountingCode: null
accountsReceivableAccountingCodeType: null
deferredRevenueAccountingCode: ''
deferredRevenueAccountingCodeType: null
recognizedRevenueAccountingCode: ''
recognizedRevenueAccountingCodeType: null
isDefault: true
isStackedDiscount: false
listPriceBase: Per_Billing_Period
numberOfPeriods: null
overageCalculationOption: null
overageUnusedUnitsCreditOption: null
priceChangeOption: null
priceIncreasePercentage: null
prices:
- currency: EUR
price: 10
- currency: JPY
price: 20
- currency: USD
price: 25
productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004
productChargeDefinitionNumber: CD-00000201
productDiscountApplyDetails: []
productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004
productRatePlanChargeNumber: null
productRatePlanId: null
productRatePlanName: null
productRatePlanNumber: null
ratingGroup: null
revRecCode: null
revRecTriggerCondition: null
revenueRecognitionRuleName: Recognize upon invoicing
smoothingModel: null
specificBillingPeriod: null
specificListPriceBase: null
taxCode: ''
taxMode: null
taxable: false
term: null
termPeriodType: null
termType: null
triggerEvent: ContractEffective
uom: null
upToPeriods: null
upToPeriodsType: null
usageRecordRatingOption: null
useDiscountSpecificAccountingCode: null
useTenantDefaultForPriceChange: true
success: true
schema:
$ref: '#/components/schemas/GETProductChargeDefinitionsResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update product charge definitions
tags:
- Product Charge Definitions
/v1/product-charge-definitions/{product-charge-definition-key}:
get:
description: |
Retrieves basic information about a product charge definition.
**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase.
operationId: GET_RetrieveProductChargeDefinition
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- description: |
The unique number or ID of the product charge definition to be retrieved.
in: path
name: product-charge-definition-key
required: true
schema:
type: string
- description: |
The flag that controls whether the response will merge the default charge definition fields for those fields that are not overridden.
in: query
name: hide-inherited-values
required: false
schema:
type: boolean
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
applyDiscountTo: null
billingDay: DefaultFromCustomer
billingPeriod: Month
billingPeriodAlignment: AlignToCharge
billingTiming: IN_ADVANCE
chargeModel: FlatFee
defaultQuantity: 1
deliverySchedule: null
description: ''
discountClass: null
discountLevel: null
effectiveEndDate: '2023-10-13 09:00:00'
effectiveStartDate: '2022-10-07 09:00:00'
endDateCondition: Subscription_End
financeInformation:
accountsReceivableAccountingCode: null
accountsReceivableAccountingCodeType: null
deferredRevenueAccountingCode: ''
deferredRevenueAccountingCodeType: null
recognizedRevenueAccountingCode: ''
recognizedRevenueAccountingCodeType: null
isDefault: true
isStackedDiscount: false
listPriceBase: Per_Billing_Period
numberOfPeriods: null
overageCalculationOption: null
overageUnusedUnitsCreditOption: null
priceChangeOption: null
priceIncreasePercentage: null
prices:
- currency: EUR
price: 10
- currency: JPY
price: 20
- currency: USD
price: 25
productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004
productChargeDefinitionNumber: CD-00000201
productDiscountApplyDetails: []
productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004
productRatePlanChargeNumber: null
productRatePlanId: null
productRatePlanName: null
productRatePlanNumber: null
ratingGroup: null
revRecCode: null
revRecTriggerCondition: null
revenueRecognitionRuleName: Recognize upon invoicing
smoothingModel: null
specificBillingPeriod: null
specificListPriceBase: null
success: true
taxCode: ''
taxMode: null
taxable: false
term: null
termPeriodType: null
termType: null
triggerEvent: ContractEffective
uom: null
upToPeriods: null
upToPeriodsType: null
usageRecordRatingOption: null
useDiscountSpecificAccountingCode: null
useTenantDefaultForPriceChange: true
schema:
$ref: '#/components/schemas/GETProductChargeDefinitionResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a product charge definition
tags:
- Product Charge Definitions
put:
description: |
Update a product charge definition.
**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase.
operationId: PUT_UpdateProductChargeDefinition
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- description: |
The unique number or ID of the product charge definition to be updated.
in: path
name: product-charge-definition-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTProductChargeDefinitionRequest'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
applyDiscountTo: null
billingPeriod: Month
billingPeriodAlignment: AlignToCharge
billingTiming: IN_ADVANCE
chargeModel: FlatFee
defaultQuantity: 1
discountClass: null
discountLevel: null
effectiveEndDate: '2023-10-13 09:00:00'
effectiveStartDate: '2022-10-07 09:00:00'
isDefault: true
listPriceBase: Per_Billing_Period
numberOfPeriods: null
prices:
- currency: USD
price: 20
productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004
productChargeDefinitionNumber: CD-00000201
productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004
productRatePlanChargeNumber: null
productRatePlanId: null
productRatePlanName: null
productRatePlanNumber: null
ratingGroup: null
smoothingModel: null
specificBillingPeriod: null
specificListPriceBase: null
success: true
taxCode: ''
taxMode: null
taxable: false
term: null
termPeriodType: null
termType: null
uom: null
schema:
$ref: '#/components/schemas/GETProductChargeDefinitionResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update a product charge definition
tags:
- Product Charge Definitions
delete:
description: |
Deletes a product charge definition.
**Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase.
operationId: DELETE_ProductChargeDefnition
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- description: |
The unique number or ID of the product charge definition to be deleted.
in: path
name: product-charge-definition-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Delete a product charge definition
tags:
- Product Charge Definitions
/v1/object/product-rate-plan-charge-tier/{id}:
get:
description: Retrieves a specific product rate plan charge tier.
operationId: Object_GETProductRatePlanChargeTier
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- description: Object fields to return
in: query
name: fields
required: false
schema:
type: string
- description: Object id
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
CreatedById: 2c93808457d787030157e02fd0f132a4
CreatedDate: '2016-10-20T05:43:38.000+02:00'
Currency: USD
EndingUnit: 0
Id: 2c93808457d787030157e02fe725341f
Price: 30
PriceFormat: Flat Fee
StartingUnit: 0
Tier: 1
UpdatedById: 2c93808457d787030157e02fd0f132a4
UpdatedDate: '2016-10-20T05:43:38.000+02:00'
schema:
$ref: '#/components/schemas/ProxyGetProductRatePlanChargeTier'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'404':
content:
application/json:
examples:
response:
value:
done: true
records: {}
size: 0
schema:
$ref: '#/components/schemas/ProxyNoDataResponse'
description: ''
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Retrieve a product rate plan charge tier'
tags:
- Product Rate Plan Charge Tiers
put:
description: |
Updates the price of a product rate plan charge tier.
To make other updates to product rate plan charge tiers, use [CRUD: Update a product rate plan charge](https://developer.zuora.com/api-references/api/operation/Object_PUTProductRatePlanCharge) and specify `ProductRatePlanChargeTierData` in the request body.
operationId: Object_PUTProductRatePlanChargeTier
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- description: |
The unique ID of the product rate plan charge tier to be updated. For example, 2c92c0f86c85891e016c88d55a6e543b.
in: path
name: id
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyModifyProductRatePlanChargeTier'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
Id: 2c92c0f86c85891e016c88d55a6e543b
Success: true
schema:
$ref: '#/components/schemas/ProxyCreateOrModifyResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: 'CRUD: Update a product rate plan charge tier'
tags:
- Product Rate Plan Charge Tiers
/v1/revpro-accounting-codes:
put:
description: Update the Zuora Revenue accounting code that corresponds to a specific Product Rate Plan Charge Id in Zuora Billing.
operationId: PUT_RevProAccountingCodes
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RevproAccountingCodes'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/PUTRevproAccCodeResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update a Zuora Revenue accounting code
tags:
- Zuora Revenue Integration
/commerce/charges:
post:
summary: Create a product rate plan charge with Dynamic Pricing
description: |
Create a product rate plan charge (PRPC) in the Product Catalog.
Use this endpoint to configure Dynamic Pricing, including default pricing at the charge level
and conditional rate cards evaluated by attribute values.
operationId: createProductRatePlanChargeWithDynamicPricing
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateChargeRequest'
examples:
perUnitExample:
summary: Per-unit charge example
value:
charge:
charge_model: per_unit
charge_type: recurring
description: description
name: charge with dimensional price 1
unit_of_measure: Each
default_quantity: 10
bill_cycle:
period: bill_cycle_period_month
period_alignment: align_to_charge
timing: in_advance
type: default_from_customer
trigger_event: contract_effective
product_rate_plan_id: f5cf096c5ca94443f76446a981e50000
end_date_condition: subscription_end
up_to_periods_type: billing_periods
up_to_periods: 0
list_price_base: Per_Billing_Period
specific_list_price_base: 0
formula: price + 1
tax_mode: non_taxable
tax_code: TAX_EXEMPT
accounting:
accounting_code: PRPC-REV-001
accounts_receivable_account: Accounts Receivable
deferred_revenue_account: Deferred Revenue
recognized_revenue_account: Recognized Revenue
contract_asset_account: Contract Asset
contract_liability_account: Contract Liability
contract_recognized_revenue_account: Contract Recognized Revenue
unbilled_receivables_account: Unbilled Receivables
adjustment_liability_account: Adjustment Liability
adjustment_revenue_account: Adjustment Revenue
revenue:
revenue_recognition_rule_name: Recognize upon invoicing
exclude_item_billing_from_revenue_accounting: false
exclude_item_booking_from_revenue_accounting: false
custom_fields:
region__c: US
channel__c: Online
netsuite:
SubsidiaryNS: US
RecognizedRevAccountNS: 4000
DeferredRevAccountNS: 2500
attributes:
- name: Age
type: Integer
mapping:
object: account
field: age__c
rate_cards:
- attributes:
- name: Age
operator: <=
value: 12
pricing:
unit_amounts:
USD: 90
- attributes:
- name: Age
operator: between
value:
- 12
- 60
pricing:
unit_amounts:
USD: 100
- attributes:
- name: Age
operator: '>='
value: 60
pricing:
unit_amounts:
USD: 80
tieredExample:
summary: Tiered charge example
value:
charge:
charge_model: tiered
charge_type: usage
name: tiered charge
unit_of_measure: Each
bill_cycle:
period: bill_cycle_period_month
period_alignment: align_to_charge
timing: in_arrears
type: default_from_customer
trigger_event: contract_effective
product_rate_plan_id: f5cf096c5ca94443f76446a981e50000
attributes:
- name: Region
type: String
rate_cards:
- attributes:
- name: Region
operator: '=='
value: US
pricing:
tiers:
- tier: '1'
from: 0
up_to: 10
price_format: price_format_per_unit
unit_amounts:
USD: 2.5
min_amounts:
USD: 6.25
max_amounts:
USD: 25
- tier: '2'
from: 11
price_format: price_format_per_unit
unit_amounts:
USD: 1.5
min_amounts:
USD: 15
max_amounts:
USD: 150
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreateChargeResponse'
examples:
response:
value:
accounting:
accountingCode: PRPC-REV-001
accountsReceivableAccount: Accounts Receivable
accountsReceivableAccountType: AccountsReceivable
deferredRevenueAccount: Deferred Revenue
deferredRevenueAccountType: DeferredRevenue
recognizedRevenueAccount: Recognized Revenue
recognizedRevenueAccountType: Recognized Revenue
adjustmentLiabilityAccount: adjustL-1
adjustmentLiabilityAccountType: AdjustmentLiability
adjustmentRevenueAccount: adjustRev-1
adjustmentRevenueAccountType: AdjustmentRevenue
contractAssetAccount: CA-2
contractAssetAccountType: ContractAsset
contractLiabilityAccount: CL-2
contractLiabilityAccountType: ContractLiability
contractRecognizedRevenueAccount: Contract Recognized Revenue
contractRecognizedRevenueAccountType: RecognizedRevenue
unbilledReceivablesAccount: unbilledR-1
unbilledReceivablesAccountType: UnbilledReceivables
productRatePlanChargeId: ad95b694d2b8442b84dc8ad26561c7d7
attributes: []
billCycle:
dayOfMonth: 5
period: bill_cycle_period_month
periodAlignment: align_to_charge
timing: in_advance
type: specific_day_of_month
chargeFunction: charge_function_standard
chargeModel: flat_fee
chargeType: recurring
createdById: 53c162482f054f3ca08e1ec82dccfec9
createdTime: '2025-10-13T07:46:02.000+00:00'
customFields: {}
discountOptions:
applyDetails: []
applyTo: []
applyToBillingPeriodPartially: false
reflectDiscountInNetAmount: false
rollover: false
stackedDiscount: false
drawdown: {}
endDateCondition: subscription_end
upToPeriodsType: billing_periods
upToPeriods: 0
extendedPrice: {}
id: ad95b694d2b8442b84dc8ad26561c7d7
isChargeLevelMinCommit: false
isCommitted: false
labels: {}
listPriceBase: Per_Billing_Period
specificListPriceBase: 0
mergedRateCards: []
name: Flat PRPC 1
negotiatedRateCards: []
ocmJsonByCurrency: {}
organizationLabels: []
overageOptions:
includedUnits: 0
unusedUnitsCreditRates: {}
prepaid: false
prepayment:
rollover: false
rolloverApply: apply_last
rolloverPeriodLength: 0
rolloverPeriods: 0
priceChangeOption: no_change
pricing:
adjustments: {}
discountAmounts: {}
discountPercentages: {}
flatAmounts:
USD: 100
maxAmounts: {}
minAmounts: {}
percentages: {}
tiers: []
unitAmounts: {}
pricingSummary:
- USD100
pricingWaterfalls: {}
productChargeDefinitions: []
productRatePlanChargeNumber: PRPC-00000279
productRatePlanId: ee2d1ce1036c4dd6ae9d6945565ff7a0
prorationOption: default_from_tenant_setting
rateCards: []
revenue:
excludeItemBillingFromRevenueAccounting: false
excludeItemBookingFromRevenueAccounting: false
legacyReporting: false
revenueRecognitionRuleName: Recognize upon invoicing
taxMode: non_taxable
taxCode: TAX_EXEMPT
taxable: false
triggerEvent: contract_effective
updatedById: 53c162482f054f3ca08e1ec82dccfec9
updatedTime: '2025-10-13T07:46:02.000+00:00'
useTenantDefaultForPriceChange: true
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyBadRequestResponse'
examples:
response:
value:
Errors:
- Code: INVALID_VALUE
Message: The account number 123xProxy is invalid.
Success: false
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
examples:
response:
value:
message: Authentication error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: The value of this header is:\n\n```\n\nBasic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API\n\n```\n
schema:
type: string
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
Zuora-Request-Id:
description: The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
tags:
- Commerce
put:
description: |
Update an existing product rate plan charge (PRPC). Use this API to update default pricing and/or conditional rate cards.
operationId: updateProductRatePlanChargeWithDynamicPricing
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateChargeRequest'
example:
charge:
id: 9c4867ed55db43a89731605d5654d4ed
pricing:
unit_amounts:
USD: 175
rate_cards:
- attributes:
- name: Age
operator: <=
value: 12
- name: EffectiveDate
operator: '>='
value: '2025-02-01T00:00:00+00:00'
pricing:
unit_amounts:
USD: 180
- attributes:
- name: Age
operator: between
value:
- 12
- 60
- name: EffectiveDate
operator: '>='
value: '2025-02-01T00:00:00+00:00'
pricing:
unit_amounts:
USD: 200
- attributes:
- name: Age
operator: '>='
value: 60
- name: EffectiveDate
operator: '>='
value: '2025-02-01T00:00:00+00:00'
pricing:
unit_amounts:
USD: 160
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreateChargeResponse'
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
'400':
description: Request Errors or Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
examples:
response:
value:
message: Authentication error
headers:
Content-Encoding:
schema:
type: string
WWW-Authenticate:
schema:
type: string
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update a product rate plan charge with Dynamic Pricing
tags:
- Commerce
/commerce/charges/query:
post:
description: |
Returns a product rate plan charge (PRPC) by evaluating Dynamic Pricing against the provided attribute values.
If a matching rate-card row is found, its pricing is returned; otherwise, the default charge-level pricing is used (if defined).
This operation can be used to simulate pricing resolution without creating or updating the charge.
operationId: queryProductRatePlanChargeWithDynamicPricing
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryChargeRequest'
examples:
minimal:
summary: Query with only the PRPC key (no attributes)
value:
product_rate_plan_charge_key: ad95b694d2b8442b84dc8ad26561c7d7
withAttributes:
summary: Query with optional attribute values
value:
product_rate_plan_charge_key: ad95b694d2b8442b84dc8ad26561c7d7
evaluation_level: LIST_PRICE
attributes:
- name: Age
number_value: 11
- name: EffectiveDate
datetime_value: '2025-02-01T00:00:00Z'
- name: AccountContext
value: Liquidity Provider
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreateChargeResponse'
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'400':
content:
application/json:
examples:
response:
value:
Errors:
- Code: INVALID_VALUE
Message: The account number 123xProxy is invalid.
Success: false
schema:
$ref: '#/components/schemas/ProxyBadRequestResponse'
description: Bad Request
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: Query a product rate plan charge with Dynamic Pricing
tags:
- Commerce
/commerce/products:
post:
summary: Create a product with plans and charges
description: |
Create a product in the Product Catalog with one or more plans and charges.
Charges can be usage (per-unit), recurring (flat fee), or other supported models.
operationId: createProduct
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProductRequest'
examples:
createProductExample:
summary: Product with one plan and one recurring flat-fee charge
value:
name: New prod
start_date: '2024-01-01'
end_date: '2050-12-31'
category: base
plans:
- name: Consumer Bronze Monthly
start_date: '2024-01-01'
end_date: '2050-12-31'
active_currencies:
- USD
charges:
- name: Flat PRPC
charge_type: recurring
charge_model: flat_fee
default_quantity: 10
min_quantity: 1
max_quantity: 999999
price_increase_percentage: 0
price_change_option: no_change
use_tenant_default_for_price_change: true
discount_options:
discount_class: ''
discount_level: rate_plan
stacked_discount: false
apply_to:
- one_time
- recurring
- usage
apply_to_billing_period_partially: false
reflect_discount_in_net_amount: false
rollover: false
specific_accounting_codes: false
apply_details: []
pricing:
flat_amounts:
USD: 100
bill_cycle:
type: specific_day_of_month
day_of_month: 5
period_alignment: align_to_charge
period: bill_cycle_period_month
timing: in_advance
trigger_event: contract_effective
end_date_condition: subscription_end
up_to_periods_type: billing_periods
up_to_periods: 0
list_price_base: Per_Billing_Period
specific_list_price_base: 0
accounting:
accounting_code: PRPC-REV-002
accounts_receivable_account: Accounts Receivable
deferred_revenue_account: Deferred Revenue
recognized_revenue_account: Recognized Revenue
adjustment_liability_account: adjustL-2
adjustment_revenue_account: adjustRev-2
contract_asset_account: CA-3
contract_liability_account: CL-3
contract_recognized_revenue_account: Contract Recognized Revenue
unbilled_receivables_account: unbilledR-2
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProductResponse'
examples:
response:
value:
allowFeatureChanges: false
category: base
contextFilters: []
createdBy: 53c162482f054f3ca08e1ec82dccfec9
createdTime: '2025-10-17T04:02:54.621-07:00'
customFields: {}
customObjects: null
description: ''
endDate: '2050-12-31'
features: []
id: 7ec58fadb6f84bc18e59c7529058d941
legacyFeatures: []
name: New prod
netsuite: null
organizationLabels: []
plans:
- activeCurrencies:
- USD
attributes: []
contextFilters: []
createTime: '2025-10-17T04:02:54.655-07:00'
createdBy: 53c162482f054f3ca08e1ec82dccfec9
customFields: {}
description: ''
displayName: ''
endDate: '2050-12-31'
entitlements: []
externalIdSourceSystem: ''
externalRateplanId: []
id: 572a2efe711b449e80cbef94419bc050
name: Consumer Bronze Monthly
netsuite: null
organizationLabels: []
productId: 7ec58fadb6f84bc18e59c7529058d941
productRatePlanCharges:
- accounting:
accountingCode: Accounts Receivable
accountsReceivableAccount: Accounts Receivable
deferredRevenueAccount: Accounts Receivable
recognizedRevenueAccount: Recognized Revenue
attributes: []
billCycle:
dayOfMonth: 5
period: bill_cycle_period_month
periodAlignment: align_to_charge
timing: in_advance
type: specific_day_of_month
chargeFunction: charge_function_standard
chargeModel: flat_fee
chargeType: recurring
createdById: 53c162482f054f3ca08e1ec82dccfec9
createdTime: '2025-10-17T04:02:54.719-07:00'
customFields: {}
discountOptions:
applyDetails: []
applyTo: []
applyToBillingPeriodPartially: false
reflectDiscountInNetAmount: false
rollover: false
stackedDiscount: false
drawdown: {}
endDateCondition: subscription_end
upToPeriodsType: billing_periods
upToPeriods: 0
extendedPrice: {}
id: 42db6ead399a4521bae91b3af469c074
isChargeLevelMinCommit: false
isCommitted: false
labels: {}
listPriceBase: Per_Billing_Period
specificListPriceBase: 0
mergedRateCards: []
name: Flat PRPC
negotiatedRateCards: []
ocmJsonByCurrency: {}
organizationLabels: []
overageOptions:
includedUnits: 0
unusedUnitsCreditRates: {}
prepaid: false
prepayment:
rollover: false
rolloverApply: apply_last
rolloverPeriodLength: 0
rolloverPeriods: 0
priceChangeOption: no_change
pricing:
adjustments: {}
discountAmounts: {}
discountPercentages: {}
flatAmounts:
USD: 100
maxAmounts: {}
minAmounts: {}
percentages: {}
tiers: []
unitAmounts: {}
pricingSummary: []
pricingWaterfalls: {}
productChargeDefinitions: []
productRatePlanChargeNumber: PRPC-00000283
productRatePlanId: 572a2efe711b449e80cbef94419bc050
prorationOption: default_from_tenant_setting
rateCards: []
revenue:
excludeItemBillingFromRevenueAccounting: false
excludeItemBookingFromRevenueAccounting: false
legacyReporting: false
revenueRecognitionRuleName: Recognize upon invoicing
taxable: false
triggerEvent: contract_effective
updatedById: 53c162482f054f3ca08e1ec82dccfec9
updatedTime: '2025-10-17T04:02:54.719-07:00'
useTenantDefaultForPriceChange: true
productRatePlanNumber: PRP-00000198
startDate: '2024-01-01'
state: active
updateTime: '2025-10-17T04:02:54.655-07:00'
updatedBy: 53c162482f054f3ca08e1ec82dccfec9
productNumber: PC-00000105
sku: SKU-00000135
startDate: '2024-01-01'
state: product_active
updatedBy: 53c162482f054f3ca08e1ec82dccfec9
updatedTime: '2025-10-17T04:02:54.621-07:00'
headers:
Content-Encoding:
description: |
Returned if `Accept-Encoding: gzip` is specified and the response exceeds 1000 bytes. Supported MIME types: application/json, application/xml, text/html, text/csv, text/plain.
schema:
type: string
RateLimit-Limit:
schema:
type: string
RateLimit-Remaining:
schema:
type: number
RateLimit-Reset:
schema:
type: number
Zuora-Request-Id:
schema:
type: string
minLength: 36
maxLength: 36
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyBadRequestResponse'
examples:
response:
value:
Errors:
- Code: INVALID_VALUE
Message: The account number 123xProxy is invalid.
Success: false
tags:
- Commerce
put:
summary: Update a product
description: |
Updates an existing product in the Product Catalog. Use this API to update core product fields
such as name, description, category, effective dates, and custom fields.
operationId: updateProduct
tags:
- Commerce
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProductRequest'
example:
id: 8ad088009840d1c2019855e15c993f2f
name: Software Service
description: Software service - basic edition
category: base
custom_fields:
HelloBay__c: Updated value
Tags__c:
- AI Powered
- Internet Required
startDate: '2025-05-11'
endDate: '2050-12-10'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProductResponse'
examples:
response:
value:
allowFeatureChanges: false
category: base
contextFilters: []
createdBy: 8a90a2fd8030ea2e018032b11d3a3f06
createdTime: '2025-08-06T18:11:35.000-07:00'
customFields: {}
customObjects: null
description: Software service - basic edition
endDate: '2050-12-31'
features: []
id: 00c86e3a0595442c88ed9ef8474b10a7
legacyFeatures: []
name: Amadeus
netsuite: null
organizationLabels: []
productNumber: PC-00000095
productRatePlans: []
sku: SKU-00000122
startDate: '2024-01-08'
state: product_active
updatedBy: 53c162482f054f3ca08e1ec82dccfec9
updatedTime: '2025-10-23T04:55:54.000-07:00'
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
'400':
description: Request Errors or Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
examples:
response:
value:
message: Authentication error
headers:
Content-Encoding:
schema:
type: string
WWW-Authenticate:
schema:
type: string
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
/commerce/plans:
post:
summary: Create a product rate plan
description: |
Create a product rate plan (Plan) under an existing product.
A plan includes one or more **charges**. Each charge **must** include:
- `name`
- `charge_model`
- `charge_type`
- `bill_cycle`
- `trigger_event`
- `end_date_condition`
- `pricing`
Optional charge fields include: `unit_of_measure`, `list_price_base`, and `accounting` (with `accounting_code`, `deferred_revenue_account`, `recognized_revenue_account`).
operationId: createPlan
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePlanRequest'
examples:
createPlanExample:
summary: Create a plan with two recurring flat-fee charges
value:
product_key: 6b14067136304e64b090daccae6680cb
name: New plan
start_date: '2024-01-01'
end_date: '2049-12-31'
active_currencies:
- USD
charges:
- name: Flat PRPC 1
charge_model: flat_fee
charge_type: recurring
pricing:
flat_amounts:
USD: 100
bill_cycle:
type: specific_day_of_month
day_of_month: 5
period_alignment: align_to_charge
period: bill_cycle_period_month
end_date_condition: subscription_end
up_to_periods_type: billing_periods
up_to_periods: 0
list_price_base: Per_Billing_Period
specific_list_price_base: 0
trigger_event: contract_effective
accounting:
accounting_code: PRPC-REV-001
accounts_receivable_account: Accounts Receivable
deferred_revenue_account: Deferred Revenue
recognized_revenue_account: Recognized Revenue
adjustment_liability_account: adjustL-1
adjustment_revenue_account: adjustRev-1
contract_asset_account: CA-2
contract_liability_account: CL-2
contract_recognized_revenue_account: Contract Recognized Revenue
unbilled_receivables_account: unbilledR-1
- name: Flat PRPC 2
charge_model: flat_fee
charge_type: recurring
pricing:
flat_amounts:
USD: 100
bill_cycle:
type: specific_day_of_month
day_of_month: 5
period_alignment: align_to_charge
period: bill_cycle_period_month
end_date_condition: subscription_end
trigger_event: contract_effective
accounting:
accounting_code: PRPC-REV-002
accounts_receivable_account: Accounts Receivable
deferred_revenue_account: Deferred Revenue
recognized_revenue_account: Recognized Revenue
adjustment_liability_account: adjustL-2
adjustment_revenue_account: adjustRev-2
contract_asset_account: CA-3
contract_liability_account: CL-3
contract_recognized_revenue_account: Contract Recognized Revenue
unbilled_receivables_account: unbilledR-2
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePlanResponse'
examples:
response:
value:
activeCurrencies:
- USD
attributes: []
contextFilters: []
createTime: '2025-10-13T07:46:02.314-07:00'
createdBy: 53c162482f054f3ca08e1ec82dccfec9
customFields: {}
description: ''
displayName: ''
endDate: '2049-12-31'
entitlements: []
externalIdSourceSystem: ''
externalRateplanId: []
id: ee2d1ce1036c4dd6ae9d6945565ff7a0
name: New plan
netsuite: null
organizationLabels: []
productId: 7228c9e6fd814e3a9e59bcdf0117e34f
productRatePlanCharges:
- accounting:
accountingCode: PRPC-REV-001
accountsReceivableAccount: Accounts Receivable
accountsReceivableAccountType: AccountsReceivable
deferredRevenueAccount: Deferred Revenue
deferredRevenueAccountType: DeferredRevenue
recognizedRevenueAccount: Recognized Revenue
recognizedRevenueAccountType: RecognizedRevenue
adjustmentLiabilityAccount: adjustL-1
adjustmentLiabilityAccountType: AdjustmentLiability
adjustmentRevenueAccount: adjustRev-1
adjustmentRevenueAccountType: AdjustmentRevenue
contractAssetAccount: CA-2
contractAssetAccountType: ContractAsset
contractLiabilityAccount: CL-2
contractLiabilityAccountType: ContractLiability
contractRecognizedRevenueAccount: Contract Recognized Revenue
contractRecognizedRevenueAccountType: RecognizedRevenue
unbilledReceivablesAccount: unbilledR-1
unbilledReceivablesAccountType: UnbilledReceivables
productRatePlanChargeId: ad95b694d2b8442b84dc8ad26561c7d7
attributes: []
billCycle:
dayOfMonth: 5
period: bill_cycle_period_month
periodAlignment: align_to_charge
timing: in_advance
type: specific_day_of_month
chargeFunction: charge_function_standard
chargeModel: flat_fee
chargeType: recurring
createdById: 53c162482f054f3ca08e1ec82dccfec9
createdTime: '2025-10-13T07:46:02.375-07:00'
customFields: {}
discountOptions:
applyToBillingPeriodPartially: false
reflectDiscountInNetAmount: false
rollover: false
stackedDiscount: false
drawdown: {}
endDateCondition: subscription_end
upToPeriodsType: billing_periods
upToPeriods: 0
listPriceBase: Per_Billing_Period
specificListPriceBase: 0
extendedPrice: {}
id: ad95b694d2b8442b84dc8ad26561c7d7
isChargeLevelMinCommit: false
isCommitted: false
labels: {}
mergedRateCards: []
name: Flat PRPC 1
negotiatedRateCards: []
ocmJsonByCurrency: {}
organizationLabels: []
overageOptions:
includedUnits: 0
unusedUnitsCreditRates: {}
prepaid: false
prepayment:
rollover: false
rolloverApply: apply_last
rolloverPeriodLength: 0
rolloverPeriods: 0
priceChangeOption: no_change
pricing:
discountAmounts: {}
discountPercentages: {}
flatAmounts:
USD: 100
maxAmounts: {}
minAmounts: {}
percentages: {}
tiers: []
unitAmounts: {}
pricingSummary: []
pricingWaterfalls: {}
productChargeDefinitions: []
productRatePlanChargeNumber: PRPC-00000279
productRatePlanId: ee2d1ce1036c4dd6ae9d6945565ff7a0
prorationOption: default_from_tenant_setting
rateCards: []
revenue:
excludeItemBillingFromRevenueAccounting: false
excludeItemBookingFromRevenueAccounting: false
legacyReporting: false
revenueRecognitionRuleName: Recognize upon invoicing
taxable: false
triggerEvent: contract_effective
updatedById: 53c162482f054f3ca08e1ec82dccfec9
updatedTime: '2025-10-13T07:46:02.375-07:00'
useTenantDefaultForPriceChange: true
productRatePlanNumber: PRP-00000195
startDate: '2024-01-01'
state: active
updateTime: '2025-10-13T07:46:02.314-07:00'
updatedBy: 53c162482f054f3ca08e1ec82dccfec9
headers:
Content-Encoding:
description: |
Returned if `Accept-Encoding: gzip` is specified and the response exceeds 1000 bytes. Supported MIME types: application/json, application/xml, text/html, text/csv, text/plain.
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion. See rate limits docs.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion. See rate limits docs.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to exhaustion. See rate limits docs.
schema:
type: number
Zuora-Request-Id:
description: The Zuora internal identifier of the API call.
schema:
type: string
minLength: 36
maxLength: 36
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyBadRequestResponse'
examples:
response:
value:
Errors:
- Code: INVALID_VALUE
Message: The account number 123xProxy is invalid.
headers:
Content-Encoding:
description: |
Returned if `Accept-Encoding: gzip` is specified and the response exceeds 1000 bytes. Supported MIME types: application/json, application/xml, text/html, text/csv, text/plain.
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion. See rate limits docs.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion. See rate limits docs.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to exhaustion. See rate limits docs.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
type: string
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
Zuora-Request-Id:
description: The Zuora internal identifier of the API call.
schema:
type: string
minLength: 36
maxLength: 36
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
tags:
- Commerce
put:
summary: Update a product rate plan
description: |
Updates an existing Product Rate Plan (PRP) in the Product Catalog.
Use this API to update core plan fields such as name, description, grade, and effective dates.
operationId: updateProductRatePlan
tags:
- Commerce
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePlanRequest'
example:
id: 5758b1d5a589840e0e6855e1c2ce014d
name: Bronze Plan
description: Basic version of our software service
grade: 1
startDate: '2025-09-10'
endDate: '2043-08-16'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePlanResponse'
examples:
response:
value:
activeCurrencies:
- USD
attributes: []
contextFilters: []
createTime: '2025-02-24T01:20:44.000+00:00'
createdBy: 8a90a2fd8030ea2e018032b11d3a3f06
customFields: {}
description: Basic version of our software service
displayName: ''
endDate: '2027-01-01'
entitlements: []
externalIdSourceSystem: ''
externalRateplanId: []
id: 38660706ef2f48cfb5222f7dde491895
name: Bronze Plan
netsuite: {}
organizationLabels: []
productId: 8a90aac8948deebf01949098b7790326
productRatePlanCharges:
- id: 99e226fec45943f4b80ed7bcf6d595d7
name: disc_currency
chargeType: recurring
chargeModel: discount_percentage
triggerEvent: contract_effective
billCycle:
period: bill_cycle_period_quarter
periodAlignment: align_to_term_start
type: term_start_day
pricing:
discountPercentages:
USD: 10
tiers: []
prepayment:
creditOption: time_based
rollover: false
rolloverApply: apply_last
rolloverPeriodLength: 0
rolloverPeriods: 0
validityPeriod: subscription_term
taxMode: non_taxable
taxable: false
createdById: 8a90a2fd8030ea2e018032b11d3a3f06
createdTime: '2025-02-24T01:21:51.000+00:00'
updatedById: 8a90a2fd8030ea2e018032b11d3a3f06
updatedTime: '2025-02-24T01:21:51.000+00:00'
- id: fe9b0e764dca4178a11c0e471e5dc0d8
name: prepay_currency
chargeType: recurring
chargeModel: flat_fee
listPriceBase: Per_Billing_Period
triggerEvent: contract_effective
billCycle:
period: bill_cycle_period_quarter
periodAlignment: align_to_term_start
timing: in_advance
type: term_start_day
pricing:
flatAmounts:
USD: 30
tiers: []
prepayment:
creditOption: consumption_based
operationType: prepaid_operation_type_topup
rollover: false
rolloverApply: apply_last
rolloverPeriodLength: 0
rolloverPeriods: 0
validityPeriod: quarter
taxMode: non_taxable
taxable: false
createdById: 8a90a2fd8030ea2e018032b11d3a3f06
createdTime: '2025-02-24T01:21:23.000+00:00'
updatedById: 8a90a2fd8030ea2e018032b11d3a3f06
updatedTime: '2025-02-24T01:21:23.000+00:00'
productRatePlanNumber: PRP-00000172
startDate: '2025-09-10'
state: active
status: ACTIVE
updateTime: '2025-10-23T05:16:28.334+00:00'
updatedBy: 53c162482f054f3ca08e1ec82dccfec9
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to exhaustion.
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
'400':
description: Request Errors or Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
examples:
response:
value:
message: Authentication error
headers:
Content-Encoding:
schema:
type: string
WWW-Authenticate:
schema:
type: string
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
/commerce/plans/query:
post:
description: |
Retrieve details of a **single** product rate plan (PRP) from the Product Catalog. You can expand associated product rate plan charges for each plan.
This operation is a **strict lookup** and **requires** `product_rate_plan_key`. It does **not** support `attributes` or other list-style filters.
To browse or filter plans (including by `attributes`), use the "Query product rate plans" operation (`POST /commerce/plans/list`).
operationId: queryCommerceProductRatePlans
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryChargeRequest'
examples:
byPlanIdExpandCharges:
summary: Query a single PRP by key and expand charges
value:
product_rate_plan_key: 572a2efe711b449e80cbef94419bc050
expand:
product_rate_plan_charges: true
byPlanKeyNoExpand:
summary: Query a single PRP by key (no expansion)
value:
product_rate_plan_key: 11dc762a07064ce496af73ff4cfb5614
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreateChargeResponse'
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'400':
content:
application/json:
examples:
response:
value:
Errors:
- Code: INVALID_VALUE
Message: The account number 123xProxy is invalid.
Success: false
schema:
$ref: '#/components/schemas/ProxyBadRequestResponse'
description: Bad Request
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: Query product rate plan details
tags:
- Commerce
/commerce/plans/list:
post:
summary: Query product rate plans
description: |
Queries product rate plans (PRPs) from the Product Catalog using filters such as plan ID, name, or product ID.
You can optionally expand related Product Rate Plan Charges (PRPCs) in the response.
operationId: queryCommercePlansList
tags:
- Commerce
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListPlansRequest'
example:
filters:
- field: prp_id
operator: EQ
value: 38660706ef2f48cfb5222f7dde491895
expand:
product_rate_plan_charges: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListPlansResponse'
examples:
response:
value:
values:
- id: 38660706ef2f48cfb5222f7dde491895
createdBy: 8a90a2fd8030ea2e018032b11d3a3f06
createTime: '2025-02-24T01:21:23.000+00:00'
updatedBy: 8a90a2fd8030ea2e018032b11d3a3f06
updateTime: '2025-02-24T01:21:23.000+00:00'
displayName: Bronze Plan
name: Bronze Plan
description: Basic version of our software service
productId: 8a90aac8948deebf01949098b7790326
startDate: '2025-09-10'
endDate: '2027-01-01'
state: active
status: ACTIVE
activeCurrencies:
- USD
productRatePlanNumber: PRP-00000172
productRatePlanCharges:
- id: fe9b0e764dca4178a11c0e471e5dc0d8
productRatePlanChargeNumber: PRPC-00000279
name: prepay_currency
chargeType: recurring
chargeModel: flat_fee
listPriceBase: Per_Billing_Period
triggerEvent: contract_effective
unitOfMeasure: Each
defaultQuantity: 1
endDateCondition: subscription_end
upToPeriodsType: billing_periods
upToPeriods: 0
billCycle:
period: bill_cycle_period_quarter
periodAlignment: align_to_term_start
timing: in_advance
type: term_start_day
pricing:
flatAmounts:
USD: 30
tiers: []
pricingSummary:
- USD30
taxMode: non_taxable
taxable: false
createdById: 8a90a2fd8030ea2e018032b11d3a3f06
createdTime: '2025-02-24T01:21:23.000+00:00'
updatedById: 8a90a2fd8030ea2e018032b11d3a3f06
updatedTime: '2025-02-24T01:21:23.000+00:00'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/commerce/products/{product_key}:
get:
description: |
Retrieves detailed information about a specific product by its unique product number or ID.
operationId: GET_RetrieveProductByKey
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
responses:
'200':
description: OK
content:
application/json:
examples:
response:
value:
id: 7228c9e6fd814e3a9e59bcdf0117e34f
createdBy: 53c162482f054f3ca08e1ec82dccfec9
createdTime: '2025-10-13T07:44:55.000-07:00'
updatedBy: 53c162482f054f3ca08e1ec82dccfec9
updatedTime: '2025-10-13T07:44:55.000-07:00'
name: New prod
description: Example product description
productNumber: PC-00000103
sku: SKU-00000133
startDate: '2024-01-01'
endDate: '2050-12-31'
category: base
customFields: {}
customObjects: null
allowFeatureChanges: false
productRatePlans:
- id: 38660706ef2f48cfb5222f7dde491895
createdBy: 53c162482f054f3ca08e1ec82dccfec9
createTime: '2025-02-24T01:21:23.000+00:00'
updatedBy: 53c162482f054f3ca08e1ec82dccfec9
updateTime: '2025-02-24T01:21:23.000+00:00'
name: Bronze Plan
displayName: Bronze Plan
description: Basic version of our software service
productId: 7228c9e6fd814e3a9e59bcdf0117e34f
startDate: '2025-09-10'
endDate: '2027-01-01'
state: active
status: ACTIVE
activeCurrencies:
- USD
productRatePlanNumber: PRP-00000172
productRatePlanCharges:
- id: fe9b0e764dca4178a11c0e471e5dc0d8
productRatePlanChargeNumber: PRPC-00000279
name: prepay_currency
description: Prepaid recurring software fee
chargeType: recurring
chargeModel: flat_fee
listPriceBase: Per_Billing_Period
specificListPriceBase: 1
triggerEvent: contract_effective
endDateCondition: subscription_end
upToPeriodsType: billing_periods
upToPeriods: 1
billCycle:
period: bill_cycle_period_quarter
periodAlignment: align_to_term_start
timing: in_advance
type: term_start_day
pricing:
flatAmounts:
USD: 30
tiers: []
pricingSummary:
- USD30
taxMode: non_taxable
taxable: false
createdById: 53c162482f054f3ca08e1ec82dccfec9
createdTime: '2025-02-24T01:21:23.000+00:00'
updatedById: 53c162482f054f3ca08e1ec82dccfec9
updatedTime: '2025-02-24T01:21:23.000+00:00'
features: []
netsuite: null
organizationLabels: []
contextFilters: []
legacyFeatures: []
dacTag:
id: 1234567890abcdef
name: Example DAC Tag
error: null
schema:
$ref: '#/components/schemas/GetProductByKeyResponse'
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
type: string
minLength: 36
maxLength: 36
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
description: Internal Server Error
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to quota exhaustion.
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
description: Request Errors
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '40010020'
message: Invalid product_key
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to quota exhaustion.
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
tags:
- Commerce
/commerce/legacy/products/list:
post:
summary: Query legacy products from the Product Catalog
description: |
This operation is functionally equivalent to the "Query products from the Product Catalog" operation, except that it returns results
in the **V1 response format**. It is primarily intended for customers migrating from older V1 integrations
who want to use new Commerce capabilities — such as **Dynamic Pricing**—without refactoring their existing integrations.
Unlike the "Query products from the Product Catalog" operation, this operation does not retrieve a different set of products.
It returns the same product catalog data as the newer operation, but formatted in a flattened V1-style response structure that:
- Uses **flattened fields** instead of grouped objects such as `discount_options`, `revenue`, or `bill_cycle`.
- Retains **V1 field names** for easier migration from existing V1 operations, for example:
- Retrieve a product rate plan charge.
- Retrieve a product rate plan.
- Retrieve a product.
- Keeps certain objects, such as `netsuite` and `customFields`, as grouped structures instead of flattening them.
**Recommended Usage**
- Use this operation if you are migrating from V1 APIs and need to maintain compatibility with existing integrations.
- For new integrations, use the "Query products from the Product Catalog" operation instead, as it returns structured responses optimized for the **Commerce** feature.
operationId: queryLegacyProducts
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProductListLegacyRequest'
examples:
queryById:
summary: Query product by ID and expand plans and charges
value:
filters:
- field: id
operator: EQ
value: 7228c9e6fd814e3a9e59bcdf0117e34f
expand:
product_rate_plans: true
product_rate_plan_charges: true
responses:
'200':
description: Successful query
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProductListLegacyResponse'
examples:
response:
value:
values:
- id: ee2d1ce1036c4dd6ae9d6945565ff7a0
name: New prod
state: active
effectiveStartDate: '2024-01-01'
effectiveEndDate: '2050-12-31'
customFields:
InexedCFTest__c: Test1
nonidxpicklist__c: nidx1
productRatePlans:
- id: c3a52dd029704b7e89274c9e7e8fd99c
name: Demo Rate Plan
state: active
activeCurrencies:
- USD
productRatePlanCharges:
- id: ebcd93dc77b34d20912dbfae5881acff
name: Charge with state 2
type: Recurring
model: PerUnit
uom: Each
billingPeriod: Month
billingTiming: IN_ADVANCE
listPriceBase: Per_Billing_Period
pricing:
- currency: USD
price: 101
tiers: []
attributes:
- name: State
type: String
mapping:
object: account
field: state__c
- name: EffectiveDate
type: Datetime
- id: 5b8ec92e6af64e8fa2d8b9756b9fed10
name: Charge with state 1
type: Recurring
model: PerUnit
uom: Each
billingPeriod: Month
billingTiming: IN_ADVANCE
listPriceBase: Per_Billing_Period
pricing:
- currency: USD
price: 100
tiers: []
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyBadRequestResponse'
examples:
response:
value:
Errors:
- Code: INVALID_VALUE
Message: The account number 123xProxy is invalid.
Success: false
headers:
Content-Encoding:
description: |-
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain`
schema:
type: string
RateLimit-Limit:
description: The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |-
The value of this header is:
``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
examples:
response:
value:
message: Authentication error
headers:
Content-Encoding:
schema:
type: string
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
type: string
Zuora-Request-Id:
description: The Zuora internal identifier of the API call.
schema:
type: string
minLength: 36
maxLength: 36
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
tags:
- Commerce
/commerce/tiers:
put:
summary: Update a product rate plan charge tier
description: |
Updates the price and other editable attributes, when supported, for a specific **Product Rate Plan Charge Tier**.
operationId: updateTier
tags:
- Commerce
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTierRequest'
example:
id: 8fe232784e7946f9aa79cfc8aad30bd9
price: 450
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTierResponse'
examples:
response:
value:
createdById: 190758cda21c41138233263a951580b3
createdTime: '2025-10-15T19:07:25.000+00:00'
currency: USD
endingUnit: 0
id: 8fe232784e7946f9aa79cfc8aad30bd9
isOveragePrice: false
price: 450
priceFormat: price_format_flat_fee
startingUnit: 0
tier: '1'
updatedById: 190758cda21c41138233263a951580b3
updatedTime: '2025-10-15T20:47:58.000+00:00'
headers:
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/commerce/purchase-options/list:
post:
description: |
Retrieves one or more product rate plans (PRPs) from the Product Catalog based on specified filters such as product ID or PRP ID.
You can optionally expand related product rate plan charges (PRPCs) in the response.
operationId: queryPurchaseOptionsbyPRPID
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOptionRequest'
examples:
byPlanIdExpandCharges:
summary: Filter by PRP ID and expand charges
value:
filters:
- field: prp_id
operator: EQ
value:
string_value: 8a90f5088799c8ed01879cb4b47a3b1a
expand:
product_rate_plan_charges: true
byProductId:
summary: Filter by Product ID
value:
filters:
- field: product_id
operator: EQ
value:
string_value: 8a90f5088799c8ed01879cb481d83b18
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOptionResponse'
examples:
sampleSuccess:
summary: Successful response with one PRP (matches the request above)
value:
error: null
productRatePlans:
- description: ''
endDate: '2026-04-20'
id: 8a90f5088799c8ed01879cb4b47a3b1a
name: New Rate Plan
product:
allowFeatureChanges: false
category: base
contextFilters: []
createdTime: '2023-04-19T20:28:08.000-07:00'
customFields:
prd_text_c__c: a
customObjects: null
description: ''
endDate: '2026-04-20'
features: []
id: 8a90f5088799c8ed01879cb481d83b18
legacyFeatures: []
name: ztax-product
netsuite: null
organizationLabels: []
productNumber: PC-00000037
productRatePlans: []
sku: SKU-00000043
startDate: '2022-04-04'
state: product_active
productId: 8a90f5088799c8ed01879cb481d83b18
productRatePlanCharges:
- accounting:
accountsReceivableAccount: Accounts Receivable
accountsReceivableAccountType: AccountsReceivable
attributes: []
billCycle:
period: bill_cycle_period_month
periodAlignment: align_to_charge
timing: in_advance
type: default_from_customer
chargeModel: flat_fee
chargeType: recurring
createdById: 2c92c8fb7a2d26b6017a2eaa64c72dea
customFieldId: '3687818732'
customFields:
IncludeTowardsMinimumCommitmentAmount__c: null
ProductType__c: null
TrueUpChargeLevel__c: null
TrueUpCharge__c: null
aaa__c: null
deliverySchedule:
frequency: delivery_frequency_unspecified
friday: false
monday: false
saturday: false
sunday: false
thursday: false
tuesday: false
wednesday: false
description: ''
discountOptions:
applyDetails: []
applyTo: []
applyToBillingPeriodPartially: false
reflectDiscountInNetAmount: false
rollover: false
stackedDiscount: false
drawdown: {}
endDateCondition: subscription_end
upToPeriodsType: billing_periods
upToPeriods: 0
listPriceBase: Per_Billing_Period
specificListPriceBase: 0
id: 8a90876c8799b81801879cb516f8400b
name: New Component
pricing:
adjustments: {}
discountAmounts: {}
discountPercentages: {}
flatAmounts:
USD: 100
maxAmounts: {}
metadata: {}
minAmounts: {}
percentages: {}
tiers: []
unitAmounts: {}
pricingSummary:
- USD100
revenue:
excludeItemBillingFromRevenueAccounting: false
excludeItemBookingFromRevenueAccounting: false
legacyReporting: false
revenueRecognitionCode: USD
revenueRecognitionRuleName: Recognize upon invoicing
taxMode: tax_exclusive
taxable: true
triggerEvent: contract_effective
updatedTime: '2023-04-19T20:28:46.000+00:00'
productRatePlanNumber: PRP-00000001
startDate: '2022-04-20'
state: active
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'400':
content:
application/json:
examples:
response:
value:
Errors:
- Code: INVALID_VALUE
Message: The account number 123xProxy is invalid.
Success: false
schema:
$ref: '#/components/schemas/ProxyBadRequestResponse'
description: Bad Request
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'401':
content:
application/json:
examples:
response:
value:
message: Authentication error
schema:
$ref: '#/components/schemas/ProxyUnauthorizedResponse'
description: Unauthorized
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
WWW-Authenticate:
description: |
The value of this header is:
```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
schema:
enum:
- Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
type: string
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: Query purchase options by PRP ID
tags:
- Commerce
/v1/accounts:
post:
description: |
Creates a customer account with a payment method, a bill-to contact,
and optional sold-to and ship-to contacts. Request and response field descriptions and sample code are provided. Use this operation to optionally create a subscription,
invoice for that subscription, and collect payment through the default payment method. The transaction is atomic; if any part fails for any reason, the entire
transaction is rolled back.
This operation is CORS Enabled, so you can use client-side Javascript to invoke the call.
### Notes
1. The account is created in active status.
2. If the `autoPay` field is set to `true` in the request, you must provide one of the `paymentMethod`, `creditCard`, or `hpmCreditCardPaymentMethodId`
field, but not multiple. The one provided becomes the default payment method
for this account. If the credit card information is declined or cannot be verified,
no account is created.
3. Customer accounts created with this call are automatically
be set to Auto Pay.
4. If the `invoiceDeliveryPrefsEmail` field is not specified
in the request, the account's email delivery preference is always automatically
set to `false`, no matter whether the `workEmail` or `personalEmail` field
is specified.
### Defaults for customerAcceptanceDate and serviceActivationDate
Default values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows.
| | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified |
| ------------- |:------------- | :-----|
| customerAcceptanceDate (CA) specified| SA uses value in the request call; CA uses value in the request call| CA uses value in the request call;SA uses CE as default |
| customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default |
This call supports a subset of the functionality of our [Create an order](https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/) call.
For use cases where you create a subscription and a billing account at the same time, we recommend using "Create an order" instead of this call.
The Orders call has the following advantages:
- Provides options for managing the entire subscription lifecycle from creation through to cancellation using different order actions.
- Allows the creation or modifying of multiple subscriptions in a single order.
- Allows a single order to combine both recurring subscription digital goods or services with order line items for physical goods.
- Orders are treated as atomic transactions. If any part fails, the entire order, subscription, and billing account creation are rolled back.
You should use this call if you need to create a standalone billing account, and create orders, subscriptions, standalone invoices, or dynamic usage charges later.
There are no deprecation plans for this call and we will continue to support this call for existing users.
operationId: POST_Account
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTAccountType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
accountId: 8ad087d2909293cb0190964171da0999
accountNumber: A00000214
billToContactId: 8ad087d2909293cb019096417222099b
soldToContactId: 8ad087d2909293cb01909641723e099e
schema:
$ref: '#/components/schemas/POSTAccountResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Create an account
tags:
- Accounts
/v1/accounts/{account-key}:
delete:
description: |
Deletes a specific account asynchronously.
**Notes and Limitations:**
- For account deletion, the system will start a backend job to remove all transactions under the accounts and change the status of the accounts to 'Cancelled'. This backend job is asynchronous and will take some time, depending on the job size.
- An account cannot be deleted when the account is either the invoice owner or the subscription owner of a subscription and the subscription's invoice owner and subscription owner are two different accounts. An exception to this limitation is if the 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.
- An account cannot be deleted if this account has ever been involved in an Owner Transfer amendment or order action, either as the current owner or as the previous owner.
operationId: DELETE_Account
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Account number or account ID.
in: path
name: account-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
id: 40288ae9600808280160081dc9c13f15
jobId: 40288ae9600808280160081db1533506
jobStatus: Pending
success: true
schema:
$ref: '#/components/schemas/DeleteAccountResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Delete an account
tags:
- Accounts
get:
description: |
Retrieves basic information about a customer account.
This operation is a quick retrieval that doesn't include the account's subscriptions, invoices, payments, or usage details. Use Get account summary to get more detailed information about an account.
operationId: GET_Account
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Account number or account ID.
in: path
name: account-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
basicInfo:
accountNumber: A00000001
batch: Batch1
communicationProfileId: 303d186840e611df817c002185d714e1
crmId: ''
id: 402892c74c9193cd014c91d35b0a0132
invoiceTemplateId: null
name: Test
notes: ''
partnerAccount: false
profileNumber: CP-00000012
salesRep: ''
sequenceSetId: null
status: Active
summaryStatementTemplateId: ff808081298c6e5401298c7a845c007b
billToContact:
address1: ''
address2: ''
city: ''
country: null
county: null
fax: ''
firstName: Test
homePhone: ''
id: 2c9081a03c6d7b51013c6d7e46c80a17
lastName: Test
mobilePhone: ''
nickname: ''
otherPhone: ''
otherPhoneType: null
personalEmail: ''
state: ''
taxRegion: null
workEmail: contact@example.com
workPhone: ''
zipCode: ''
billingAndPayment:
additionalEmailAddresses:
- contact1@example.com
- contact2@example.com
autoPay: true
billCycleDay: 1
currency: USD
defaultPaymentMethodId: 2c93808457d787030157e03220ec4fad
invoiceDeliveryPrefsEmail: true
invoiceDeliveryPrefsPrint: false
paymentMethodCascadingConsent: false
paymentGateway: TestGateway
paymentTerm: Net 30
einvoiceProfile:
businessCategory: B2B
businessName: legal business name
businessNumber: '20002039'
businessNumberSchemeId: '88'
enabled: true
endpointId: '8992'
endpointSchemeId: '88'
taxRegisterNumber: TAX393999
metrics:
balance: 0
contractedMrr: -900
creditBalance: 0
totalInvoiceBalance: 0
metricsData:
- balance: 0
contractedMrr: -900
currency: USD
reservedPaymentAmount: 900
totalDebitMemoBalance: 0
totalInvoiceBalance: 0
unappliedCreditMemoAmount: 0
unappliedPaymentAmount: 0
- balance: 0
contractedMrr: -900
currency: EUR
reservedPaymentAmount: -900
totalDebitMemoBalance: 0
totalInvoiceBalance: 0
unappliedCreditMemoAmount: 0
unappliedPaymentAmount: 0
soldToContact:
address1: ''
address2: ''
city: ''
country: null
county: null
fax: ''
firstName: Test
homePhone: ''
id: 2c9081a03c6d7b51013c6d7e46cf0a18
lastName: Test
mobilePhone: ''
nickname: ''
otherPhone: ''
otherPhoneType: null
personalEmail: ''
state: ''
taxRegion: null
workEmail: contact@example.com
workPhone: ''
zipCode: ''
success: true
schema:
$ref: '#/components/schemas/GETAccountType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve an account
tags:
- Accounts
put:
description: |
Updates a customer account by specifying the account-key.
### Notes
1. Only the fields to be changed should be specified. Any field that is not included in the request body will not be changed.
2. If an empty field is submitted with this operation, the corresponding field in the account is emptied.
3. Email addresses: If no email addresses are specified, no change is made to the email addresses or to the email delivery preference. If either the **personalEmail** or **workEmail** of **billToContact** is specified (or both), the system updates the corresponding email address(es) and the email delivery preference is set to `true`. (In that case, emails go to the **workEmail** address, if it exists, or else the **personalEmail**.) On the other hand, if as a result of this call both of the email addresses for the account are empty, the email delivery preference is set to `false`.
4. The Bill To, Sold To, and Ship To contacts are separate contact entities. However, if you set the `soldToSameAsBillTo` field to `true` when creating an account, the Bill To and Sold To contacts will refer to the same contact entity. As a result, updating either contact will update both. The same behavior applies to the `shipToSameAsBillTo` field and the Ship To contact. In this case, if you want to update only one of the contacts, you must create a new contact and then update the Bill To, Sold To, or Ship To contact to reference the newly created one.
operationId: PUT_Account
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Account number or account ID.
in: path
name: account-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTAccountType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update an account
tags:
- Accounts
/v1/accounts/{account-key}/payment-methods:
get:
description: |
Retrieves the payment methods of the specified customer account.
**Note:** This operation also supports retrieving custom payment methods created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service.
operationId: GET_AcountPaymentMethods
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Account number or account ID.
in: path
name: account-key
required: true
schema:
type: string
- description: Indicates whether to only retrieve the default payment method of the account. The default value is `false`. If this parameter is set to `true`, only the default payment method is retrieved.
in: query
name: isDefaultOnly
required: false
schema:
type: boolean
- description: Indicates whether to only retrieve the active payment methods of the account. The default value is `false`. If this parameter is set to `true`, only the active payment methods are retrieved.
in: query
name: isActiveOnly
required: false
schema:
type: boolean
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
ach:
- AA_PICKLIST__c: null
accountHolderInfo:
accountHolderName: null
addressLine1: DSDFD
addressLine2: ''
city: Example City
country: United States
email: test@test.com
phone: '2554444'
state: Example State
zipCode: '123456'
accountKey: 4028839f7ca29000017ca29c1ce8003f
bankABACode: '110000000'
bankAccountName: Test
bankAccountNumber: '********6789'
bankAccountType: Checking
bankIdentificationNumber: null
bankName: Chase
createdBy: 402881e522cf4f9b0122cf5d82860002
createdDate: '2021-10-27 05:32:19'
deviceSessionId: null
existingMandate: null
id: 4028839f7cc14262017cc1bca9eb0008
ipAddress: null
isDefault: false
lastFailedSaleTransactionDate: null
lastTransaction: Approved
lastTransactionDateTime: '2021-10-27 05:32:19'
lastTransactionStatus: Approved
mandateInfo:
existingMandateStatus: null
mandateCreationDate: null
mandateId: null
mandateReason: null
mandateReceivedStatus: null
mandateStatus: null
mandateUpdateDate: null
maxConsecutivePaymentFailures: null
numConsecutiveFailures: 0
paymentRetryWindow: null
status: Active
totalNumberOfErrorPayments: 0
totalNumberOfProcessedPayments: 0
type: ACH
updatedBy: 402881e522cf4f9b0122cf5d82860002
updatedDate: '2021-11-10 00:50:12'
useDefaultRetryRule: true
creditcard:
- AA_PICKLIST__c: null
accountHolderInfo:
accountHolderName: John Smith
addressLine1: ABC
addressLine2: EFT
city: Example City
country: United States
email: example@google.com
phone: '86123456789'
state: Example State
zipCode: '123456'
accountKey: 4028839f7ca29000017ca29c1ce8003f
bankIdentificationNumber: '411111'
cardNumber: '************1111'
createdBy: 402881e522cf4f9b0122cf5d82860002
createdDate: '2021-11-15 18:59:08'
creditCardType: Visa
deviceSessionId: null
existingMandate: null
expirationMonth: 11
expirationYear: 2027
id: 4028839f7d26a155017d26af16ef0001
identityNumber: '97370192024'
ipAddress: null
isDefault: true
lastFailedSaleTransactionDate: null
lastTransaction: Approved
lastTransactionDateTime: '2021-11-15 18:59:08'
lastTransactionStatus: Approved
mandateInfo:
mitConsentAgreementRef: null
mitConsentAgreementSrc: null
mitProfileAction: null
mitProfileAgreedOn: null
mitProfileType: null
mitTransactionId: null
maxConsecutivePaymentFailures: null
numConsecutiveFailures: 0
paymentRetryWindow: null
status: Active
totalNumberOfErrorPayments: 0
totalNumberOfProcessedPayments: 0
type: CreditCard
updatedBy: 402881e522cf4f9b0122cf5d82860002
updatedDate: '2021-11-15 18:59:08'
useDefaultRetryRule: true
creditcardreferencetransaction:
- AA_PICKLIST__c: null
accountHolderInfo:
accountHolderName: ''
addressLine1: ''
addressLine2: ''
city: ''
country: null
email: ''
phone: null
state: ''
zipCode: ''
accountKey: 4028839f7ca29000017ca29c1ce8003f
bankIdentificationNumber: null
cardNumber: null
createdBy: 402881e522cf4f9b0122cf5d82860002
createdDate: '2021-11-03 22:35:59'
creditCardType: Visa
deviceSessionId: null
existingMandate: null
expirationMonth: 11
expirationYear: 2021
id: 4028839f7ce8c530017ce9725e2c0003
ipAddress: null
isDefault: false
lastFailedSaleTransactionDate: null
lastTransaction: Approved
lastTransactionDateTime: '2021-11-03 22:35:59'
lastTransactionStatus: Approved
mandateInfo:
mitConsentAgreementRef: null
mitConsentAgreementSrc: null
mitProfileAction: null
mitProfileAgreedOn: null
mitProfileType: null
mitTransactionId: null
maxConsecutivePaymentFailures: null
numConsecutiveFailures: 0
paymentRetryWindow: null
secondTokenId: FGDSDF
status: Active
tokenId: ABCE
totalNumberOfErrorPayments: 0
totalNumberOfProcessedPayments: 0
type: CreditCardReferenceTransaction
updatedBy: 402881e522cf4f9b0122cf5d82860002
updatedDate: '2021-11-03 22:35:59'
useDefaultRetryRule: true
debitcard:
- AA_PICKLIST__c: null
accountHolderInfo:
accountHolderName: John Smith
addressLine1: 1051 E Hillsdale Blvd
addressLine2: ''
city: Tynan
country: United States
email: smith@example.com
phone: ''
state: California
zipCode: '45101'
accountKey: 4028839f7ca29000017ca29c1ce8003f
bankIdentificationNumber: '588888'
cardNumber: '************8888'
createdBy: 402881e522cf4f9b0122cf5d82860002
createdDate: '2021-11-01 00:01:52'
creditCardType: Electron
deviceSessionId: null
existingMandate: null
expirationMonth: 11
expirationYear: 2021
id: 4028839f7cd92a6b017cda4defd00006
ipAddress: null
isDefault: false
lastFailedSaleTransactionDate: null
lastTransaction: Approved
lastTransactionDateTime: '2021-11-01 00:01:53'
lastTransactionStatus: Approved
mandateInfo:
mitConsentAgreementRef: null
mitConsentAgreementSrc: null
mitProfileAction: null
mitProfileAgreedOn: null
mitProfileType: null
mitTransactionId: null
maxConsecutivePaymentFailures: null
numConsecutiveFailures: 0
paymentRetryWindow: null
status: Active
totalNumberOfErrorPayments: 0
totalNumberOfProcessedPayments: 0
type: CreditCard
updatedBy: 402881e522cf4f9b0122cf5d82860002
updatedDate: '2021-11-01 00:01:52'
useDefaultRetryRule: true
defaultPaymentMethodId: 4028839f7d26a155017d26af16ef0001
paymentGateway: null
success: true
schema:
$ref: '#/components/schemas/GETAccountPaymentMethodType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List payment methods of an account
tags:
- Accounts
/v1/accounts/{account-key}/payment-methods/cascading:
get:
summary: Retrieve configuration of cascading payment methods for an account
description: |
Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to retrieve the configuration information for Cascading Payment Method of a specified account, including the cascading consent value and the priority list of payment methods.
Before you use this API operation, ensure that the Cascading Payment Method feature is enabled. For more information about the Cascading Payment Method feature, see Cascade payment methods.
operationId: GetAccountPaymentMethodCascading
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Account ID.
in: path
name: account-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
responses:
'200':
content:
application/json:
examples:
response:
value:
consent: true
priorities:
- paymentMethodId: 2c92c0f95be68649015bf14e001f2760
order: 1
- paymentMethodId: 2c92c0f95be68649015bf14e001f2761
order: 2
- paymentMethodId: 2c92c0f95be68649015bf14e001f2762
order: 3
success: true
schema:
$ref: '#/components/schemas/GetCascadingPaymentMethodsConfigurationResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
tags:
- Accounts
put:
summary: Configure cascading payment methods for an account
description: |
Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to configure the cascading consent for a specified account and set up the priority list of payment methods to be used in Cascading Payment Method.
Before you use this API operation, ensure that the Cascading Payment Method feature is enabled. For more information about the Cascading Payment Method feature, see Cascade payment methods.
operationId: PutAccountPaymentMethodCascading
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Account ID.
in: path
name: account-key
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PutCascadingPaymentMethodsConfigurationRequest'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
tags:
- Accounts
/v1/accounts/{account-key}/payment-methods/default:
get:
description: |-
Retrieves the default payment method of the specified customer account.
**Notes:** **Note:** The value of this column is optional, but the column header is required.
| No | | PRODUCT_RATE_PLAN_CHARGE_ID | Enter a product rate plan charge number so that you can charge your customer with a dynamic usage charge for the corresponding uploaded usage record.**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 | | 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 | | 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 | | DESCRIPTION | Enter a description for the charge. | No | | UNIQUE_KEY | Enter a specific identifier for this usage record. **Note**: This Heading is supported by the following features: Prepaid with Drawdown, and Unbilled Usage. See Upload usage record with unique key for more information. | No | operationId: POST_Usage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: description: | The usage data to import. The supported formats are excel, csv, and zip. format: binary type: string required: - file type: object required: true responses: '200': content: application/json: examples: response: value: checkImportStatus: /v1/usage/2c92c8f83dcbd8b1013dcce1159900cc/status size: 316 success: true schema: $ref: '#/components/schemas/POSTUsageResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a usage file tags: - Usage x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@UsageData.csv" "https://rest.zuora.com/v1/usage" /v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail: get: description: | Use this REST API operation to retrieve the usage rate detail for an invoice item to understand how the total amount is calculated. The information is the same as the Rate Detail presented on [PDF invoices](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Create_a_custom_invoice_template/DD_Display_Usage_Charge_Breakdown#How_UsageSummary.RateDetail_is_displayed_on_invoices). **Notes and limitations:** - Do not support the Overage Charge Model, Tiered with Overage Charge Model, and Multi-attribute Pricing Charge Model. - Do not support invoices in `Cancelled` or `Reversed` status. - Do not support Active rating. - In terms of rating group options, only the [Usage rating by billing period](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Rating/Usage_Rating_by_Group#Usage_rating_by_billing_period) is supported. - Do not support [On-demand usage rating](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Rating/On-demand_Usage_Rating). - Tax calculation is not involved. operationId: GET_Usage_Rate_Detail_By_Invoice_Item parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Invoice item ID. For example, `402880e57f725d85017f7267c4ad002b`. Available through Data Source export. in: path name: invoice-item-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: data: amountWithoutTax: 58 chargeNumber: C-00000001 invoiceId: 402880e57f725d85017f7267c44c0028 invoiceItemId: 402880e57f725d85017f7267c4ad002b invoiceNumber: INV00000007 listPrice: | Tier / From / To / List Price / Price Format 1 / 0 / 9 / 0.00 / Per Unit 2 / 10 / 20 / 1.00 / Per Unit 3 / 21 / 30 / 2.00 / Flat Fee 4 / 31 / / 3.00 / Per Unit quantity: 45 rateDetail: |- Tier 1: 0-9, 9 Each(s) x $0.00/Each = $0.00 Tier 2: 10-20, 11 Each(s) x $1.00/Each = $11.00 Tier 3: 21-30, $2.00 Flat Fee Tier 4: >=31, 15 Each(s) x $3.00/Each = $45.00 Total = $58.00 servicePeriod: 03/01/2022-03/31/2022 uom: Each success: true schema: $ref: '#/components/schemas/GETUsageRateDetailWrapper' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve usage rate detail for an invoice item tags: - Usage /v1/object/usage: post: description: Creates a usage record. operationId: Object_POSTUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateUsage' required: true responses: '200': content: application/json: examples: response: value: Id: 8ad08ae29085a77b0190908bfdd67abb Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: examples: response: value: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Create a usage record' tags: - Usage /v1/object/usage/{id}: delete: description: Deletes a usage record. operationId: Object_DELETEUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyDeleteResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Delete a usage record' tags: - Usage get: description: Retrieve a usage record. operationId: Object_GETUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object fields to return in: query name: fields required: false schema: type: string - description: Object id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: AccountId: 2c92c0f956bc8fb40156d502fc3718b1 AccountNumber: A00000030 ChargeId: 2c92c0f956bc8fcb0156d5039e275aa9 ChargeNumber: C-00000229 CreatedById: 2c92c0f958fffd7d015914aeefc71a5d CreatedDate: '2019-07-18T15:36:43.000+08:00' Description: test Id: 2c92c0f86bf50ca0016c040309316ca4 Quantity: 9 RbeStatus: Pending SourceType: API StartDateTime: '2017-12-01T23:41:36.000+08:00' SubmissionDateTime: '2019-07-18T15:36:43.000+08:00' SubscriptionId: 2c92c0f956bc8fcb0156d5039e0a5aa0 SubscriptionNumber: A-S00000100 UOM: Each UpdatedById: 2c92c0f958fffd7d015914aeefc71a5d UpdatedDate: '2019-07-18T15:36:43.000+08:00' schema: $ref: '#/components/schemas/ProxyGetUsage' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '404': content: application/json: examples: response: value: done: true records: {} size: 0 schema: $ref: '#/components/schemas/ProxyNoDataResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Retrieve a usage record' tags: - Usage put: description: Updates a usage record. operationId: Object_PUTUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyModifyUsage' required: true responses: '200': content: application/json: examples: response: value: Id: 8ad08ae29085a77b0190908bfdd67abb Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Update a usage record' tags: - Usage /meters/run/{meterId}/{version}: post: tags: - Meters summary: Run a specific version of a meter description: | Executes a specific version of a meter in Zuora Mediation. You can choose to run it with either a local file or event store source by providing optional configurations. operationId: runSpecificVersionOfMeter parameters: - name: meterId in: path required: true description: The ID of the meter to run. schema: type: string - name: version in: path required: true description: The version of the meter to run. schema: type: string - name: Content-Type in: header required: true description: Specify the content type of the request body. Use application/json. schema: type: string default: application/json - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/RunMeterVersionRequest' responses: '200': description: Successful meter run content: application/json: schema: $ref: '#/components/schemas/RunMeterVersionResponse' examples: success: summary: Meter run success example value: success: true data: id: '5468' sessionId: R-00005468 jobId: da0b43468d6a41eaad03e559d6aecceb meterId: 2470 version: 0.0.1 revision: 1 runType: 1 runTypeDescription: NORMAL startTime: '2025-03-31T09:17:21.192927441Z' status: 10 statusDescription: INITIALIZING canExportSummary: false hasLineageEnabled: false '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '401': description: Unauthorized request content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /meters/debug/{meterId}/{version}: post: tags: - Meters summary: Test a specific version of a meter description: Test a specific version of a meter in Zuora Mediation without executing a full run. It supports multiple input methods, including uploaded files, sample files, and manual test data. This is useful for validating meter logic and transformations before meter run. operationId: testSpecificVersionOfMeter parameters: - name: meterId in: path description: The ID of the meter to be tested. required: true schema: type: integer - name: version in: path description: The version of the meter to be tested. required: true schema: type: string - name: Content-Type in: header required: true description: Specify the content type of the request body. Use application/json. schema: type: string default: application/json - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TestSpecificMeterRequest' responses: '200': description: Successfully tested meter version. content: application/json: schema: $ref: '#/components/schemas/TestSpecificMeterResponse' '400': description: Bad Request - Invalid or missing parameters. content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '401': description: Unauthorized - Authentication failed. content: application/json: schema: $ref: '#/components/schemas/MediationErrorResponse' '500': description: Internal Server Error - Unexpected error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /meters/{meterId}/summary: post: tags: - Meters summary: Retrieve summary data for a meter description: Retrieves summary data for a specific meter in Zuora Mediation, providing a rolled-up view of a meter run or time window. The API supports grouping by Operator ID, Error Code, or Session ID, and allows optional filters such as Query From Time, Query To Time, Operator IDs, and Session IDs. The API returns aggregated output and error counts per group and includes validation with detailed error responses for invalid parameters or formats. operationId: retrieveMeterSummaryData parameters: - name: meterId in: path description: The ID of the meter. required: true schema: type: integer format: int64 - name: Content-Type in: header required: true description: Specify the content type of the request body. Use application/json. schema: type: string default: application/json - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateSpecificMeterSummaryRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateSpecificMeterSummaryResponse' example: success: true data: requestId: 91d46fea-67de-4abe-9cc3-6ef076bbb7ea requestTime: '2025-11-20T16:41:27.858661268Z' query: runType: NORMAL sessionIds: null operatorIds: null groupBy: - sessionId queryFromTime: null queryToTime: null output: - dimensions: sessionId: R-00002283 output: 10000000 totalErrorCount: 0 - dimensions: sessionId: R-00002340 output: 10000000 totalErrorCount: 0 previousPage: null nextPage: null '400': description: Bad Request - Invalid or missing parameters. content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '401': description: Unauthorized - Authentication failed. content: application/json: schema: $ref: '#/components/schemas/MediationErrorResponse' '500': description: Internal Server Error - Unexpected error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /meters/{meterId}/{version}/runStatus: get: tags: - Meters summary: Retrieve the run status of a specific meter version description: Retrieves the current run status of a specific meter version in Zuora Mediation. It returns an integer code indicating the status, such as `RUNNING`, `COMPLETED`, or `FAILED`, which helps monitor the meter's execution state. operationId: getRunStatusOfSpecificMeterVersion parameters: - name: meterId in: path required: true description: ID of the meter. schema: type: integer - name: version in: path required: true description: Version of the meter. schema: type: string - name: Content-Type in: header required: true description: Specify the content type of the request body. Use application/json. schema: type: string default: application/json - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' responses: '200': description: Successful response with run status data content: application/json: schema: $ref: '#/components/schemas/RunStatusResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '404': description: Meter not found content: application/json: schema: $ref: '#/components/schemas/MediationErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /meters/{meterId}/auditTrail/entries: get: tags: - Meters summary: Retrieve the audit trail entries for a meter description: Retrieves the audit trail entries for a specific meter in Zuora Mediation. The API provides detailed, record-level information about what happened during processing, including Payload and error details, operator information, and the trace ID/event ID. operationId: getAuditTrailEntriesForMeter parameters: - name: meterId in: path required: true description: ID of the meter. schema: type: integer format: int64 - name: exportType in: query required: true description: Type of the export. schema: type: string - name: runType in: query required: true description: Specifies the type of run. schema: type: string - name: sessionId in: query required: false description: | A specific session ID. schema: type: string - name: queryFromTime in: query required: true description: | The minimum timestamp of the audit trail data. schema: type: string - name: queryToTime in: query required: true description: | The maximum timestamp of the audit trail data. schema: type: string - name: operatorId in: query required: false description: | The ID of the operator. schema: type: string - name: pageSize in: query required: false description: | Page size for pagination. schema: type: integer format: int32 default: 30 - name: cursor in: query required: false description: | nextPage token from previous response. 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/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. schema: type: string - name: sessionIds in: query required: false description: | The session IDs of the meter run. schema: type: array items: type: string - name: pageSize in: query required: false description: | Page size for pagination. schema: type: integer format: int32 default: 30 - name: page in: query required: false description: | The page number. schema: type: integer format: int32 default: 1 - name: Content-Type in: header required: true description: Specify the content type of the request body. Use application/json. schema: type: string default: application/json - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetAuditTrailExportResponse' example: success: true data: page: 1 pageSize: 5 jobs: - requestId: cd3367fb-019d-4600-863f-07c51b7c9e10 meterId: 709 query: operatorIds: [] exportType: SAMPLE runType: NORMAL queryToTime: '2025-11-20T23:59:59Z' queryFromTime: '2025-11-13T07:02:11Z' format: csv statuses: null sessionIds: [] status: FINISHED count: 15001524 creationTime: '2025-11-20T16:40:58Z' completionTime: '2025-11-20T16:49:01Z' fileList: - cd3367fb-019d-4600-863f-07c51b7c9e10/audit_trail.csv previousPage: null nextPage: null '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' post: tags: - Meters summary: Create a job to export audit trail data for a meter description: Creates a background job to export the audit trail entries for a specific meter in Zuora Mediation. This API is for large-scale, offline access to audit data. Only one export job is processed per tenant at a time, and each export has a record limit, for example, up to 5 million rows per report. Use the returned requestId with the "Retrieve the list of export jobs for a meter" API operation to track the job status and retrieve the generated file names from `fileList`, then download them using the "Retrieve the presigned URL for an export job" API operation. operationId: createAuditTrailExportJob parameters: - name: meterId in: path description: The ID of the meter. required: true schema: type: integer format: int64 - name: exportType in: query required: true description: Type of the export. schema: type: string - name: runType in: query required: true description: Specifies the type of run. schema: type: string - name: sessionIds in: query required: false description: | A list of specific run IDs to export. schema: type: array items: type: string - name: runStatuses in: query required: false description: | Filters audit entries by their run status. If null, all statuses are included. schema: type: array items: type: string - name: operatorIds in: query required: false description: | A list of operator IDs to filter by. schema: type: array items: type: string - name: queryFromTime in: query required: true description: | The minimum timestamp for the data to be exported. schema: type: string - name: queryToTime in: query required: true description: | The maximum timestamp for the data to be exported. schema: type: string - name: format in: query required: false description: | The required format for the exported data. schema: type: string default: csv - name: Content-Type in: header required: true description: Specify the content type of the request body. Use application/json. schema: type: string default: application/json - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportAuditTrailResponse' example: success: true data: requestId: cd3367fb-019d-4600-863f-07c51b7c9e10 previousPage: null nextPage: null '400': description: Bad Request - Invalid or missing parameters. content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '401': description: Unauthorized - Authentication failed. content: application/json: schema: $ref: '#/components/schemas/MediationErrorResponse' '500': description: Internal Server Error - Unexpected error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /meters/auditTrail/presignedUrl: get: tags: - Meters summary: Retrieve the presigned URL for an export job description: Returns a pre-signed URL that you can use to download a specific export file (usually from object storage such as S3). The `fileKey` corresponds to one entry from the `fileList` array in the List API. Use the returned URL in the data field directly in a browser or via a HTTP client to download the export file. operationId: getPresignedURLForMeterExport parameters: - name: fileKey in: query required: true description: The file key of the export file to download. schema: type: string - name: Content-Type in: header required: true description: Specify the content type of the request body. Use application/json. schema: type: string default: application/json - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetPresignedURLResponse' example: success: true data: https://s3.us-west-2.amazonaws.com/example-bucket/tenant-exports/12345/audit-trail/export-2025-01-01/errors_SAMPLE.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAEXAMPLE123456789%2F20250101%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20250101T000000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=0000000000000000000000000000000000000000000000000000000000000000 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /meters/export/{meterId}: get: tags: - Meters summary: Export details of a specific meter description: | The Export Meter operation exports the full definition of a specific meter in Zuora Mediation, including metadata, all versions, event schemas, and operator configurations (source, processor, sink). It's useful for reviewing, backing up, or replicating meter setups across environments. operationId: exportSpecificMeter parameters: - name: meterId in: path required: true description: ID of the meter to export. schema: type: string - name: Content-Type in: header required: true description: Specify the content type of the request body. Use application/json. schema: type: string default: application/json - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' responses: '200': description: Successful response with meter export data content: application/json: schema: $ref: '#/components/schemas/ExportMeterResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '404': description: Meter not found content: application/json: schema: $ref: '#/components/schemas/MediationErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /meters/import: post: tags: - Meters summary: Import a meter definition description: | Import a meter definition into Zuora Mediation using a file exported from the Export Meter API. operationId: importMeterDefinition requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/ImportMeterRequest' parameters: - in: header name: Content-Type required: true schema: type: string example: multipart/form-data description: Content type for the request body. - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' responses: '200': description: Successful import of meter definition content: application/json: schema: $ref: '#/components/schemas/ImportMeterResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '401': description: Unauthorized access content: application/json: schema: $ref: '#/components/schemas/MediationErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /meters/files: post: tags: - Meters summary: Upload a file description: | Uploads and stores a file in Zuora Mediation for use in meter processing. Supported formats include CSV, Excel, and JSON. You can specify metadata like headers, delimiters, sheets, and data ranges. operationId: uploadMeteringFile requestBody: content: multipart/form-data: schema: type: object required: - file properties: file: type: string format: binary description: The file to store hasHeader: type: boolean description: Indicates if the file has a header (for CSV/Excel) firstRow: type: integer description: Indicates where the first row starts (for CSV format) delimiter: type: string description: Delimiter to separate values (for CSV format) sheet: type: string description: The sheet where data lives (for Excel) dataRange: type: string description: The data range in the sheet (for Excel) resolveFileNameConflict: type: boolean description: Whether to generate a UUID file name targetFolder: type: string description: The target folder to store the file overwriteExistingFile: type: boolean description: Whether to overwrite an existing file responses: '200': description: File successfully uploaded content: application/json: schema: $ref: '#/components/schemas/CreateFileResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /usage/bulk/{meterGlobalId}: post: summary: Ingest usage events for a meter tags: - Meters description: | Ingests usage events directly into Zuora Mediation in real time. You can send a single event or batch multiple events in a JSON array to optimize throughput. Each event must conform to the meter's event schema. operationId: ingestUsageEvents parameters: - name: Content-Type in: header required: true description: Specify the content type of the request body. Use application/json. schema: type: string default: application/json - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: meterGlobalId in: path required: true description: The global ID of the meter. schema: type: string requestBody: description: A JSON object or an array of objects representing usage events. Each event must conform to the event schema defined in your meter. required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/StreamingEvent' - type: array items: $ref: '#/components/schemas/StreamingEvent' responses: '200': description: Usage event(s) ingested successfully. content: application/json: schema: $ref: '#/components/schemas/StreamingIngestionSuccessResponse' '400': description: Bad request due to validation or business logic errors. content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '401': description: Unauthorized request. content: application/json: schema: $ref: '#/components/schemas/StreamingIngestionAuthError' '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/StreamingIngestionAuthError' '413': description: Payload too large. content: application/json: schema: $ref: '#/components/schemas/StreamingIngestionAuthError' '429': description: Too many requests. content: application/json: schema: $ref: '#/components/schemas/StreamingIngestionAuthError' '500': description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /meters/events/bulkDelete: post: tags: - Meters summary: Bulk delete events from an event store description: | Allows you to delete multiple events from an event store in Zuora Mediation using a file that lists the event IDs to be removed. It is useful for cleaning up or correcting data in bulk. operationId: bulkDeleteEventsFromEventStore parameters: - name: Content-Type in: header required: true description: Specify the content type of the request. Use multipart/form-data. schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/BulkDeleteEventRequest' responses: '200': description: Successful response with query ID content: application/json: schema: $ref: '#/components/schemas/BulkDeleteEventResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /meters/events/stores/{id}/jobs/latest: get: tags: - Meters summary: Retrieve the latest query job of a specific event store description: Retrieves the most recent query job executed on a specific event store in Zuora Mediation. It returns metadata such as query type (e.g., DELETE), status, record counts, and timestamps. operationId: getLatestQueryJobOfSpecificEventStore parameters: - name: id in: path required: true description: ID of the event store. schema: type: integer - name: Content-Type in: header required: true description: Specify the content type of the request. Use application/json. schema: type: string default: application/json - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' responses: '200': description: Successful response with latest event store query job details content: application/json: schema: $ref: '#/components/schemas/LatestEventStoreJobResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ProxyBadRequestResponse' '404': description: Event store not found content: application/json: schema: $ref: '#/components/schemas/MediationErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /v1/commitments: get: tags: - Commitments summary: List commitments for an account description: Retrieves a paginated list of commitments for a commitment owner account. operationId: getCommitments parameters: - name: accountNumber in: query required: true description: Account number to fetch commitments for. schema: type: string - name: type in: query required: false description: Filter commitments by type. schema: type: string format: CommitmentTypeEnum enum: - MinCommitment - MaxCommitment example: MinCommitment - name: page in: query required: false description: Page number for pagination. schema: type: integer minimum: 1 default: 1 - name: pageSize in: query required: false description: Page size for pagination. schema: type: integer minimum: 1 maximum: 100 default: 20 - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetCommitmentsResponse' example: total: 1 page: 1 page_size: 20 commitments: - id: 8ad08ca797ef6ca50197f3cce6267991 status: Active version: 1 currency: USD startDate: '2020-01-01' endDate: '2020-12-31' amount: 100 orderNumber: O-0001 orderId: 00989e98483e00030a2733ee989e9815 accountId: 8a8aa0ac7f3b4c1d017f3b4c1d0a0001 accountNumber: ACC-0001 commitmentNumber: TW-0001 name: Example Commitment type: MinCommitment description: This a example commitment. priority: 1 eligibleAccountConditions: field: Account.AccountNumber operator: eq value: ACC-0001 conditions: - {} relation: and eligibleChargeConditions: field: RatePlanCharge.ChargeNumber operator: in value: C-0001,C-0002 conditions: - {} relation: and customFields: {} excludeItemBookingFromRevenueAccounting: true adjustmentLiabilityAccountingCode: Accounts Receivable adjustmentRevenueAccountingCode: Accounts Receivable contractAssetAccountingCode: Accounts Receivable contractLiabilityAccountingCode: Accounts Receivable contractRecognizedRevenueAccountingCode: Accounts Receivable deferredRevenueAccountingCode: Accounts Receivable excludeItemBillingFromRevenueAccounting: false isAllocationEligible: true isUnbilled: false recognizedRevenueAccountingCode: Accounts Receivable revenueRecognitionRule: Recognize upon invoicing unbilledReceivablesAccountingCode: Accounts Receivable revenueRecognitionTiming: Upon Order Activation Date revenueAmortizationMethod: string accountReceivableAccountingCode: Accounts Receivable taxable: true taxCode: SalesTax_US taxMode: TaxInclusive '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /v1/commitments/{commitment-key}: get: tags: - Commitments summary: Retrieve a commitment description: Retrieves the details of a specific commitment using its ID or number. operationId: getCommitmentByKey parameters: - name: commitment-key in: path required: true description: The unique identifier (ID or number) of the commitment. schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetCommitmentResponse' example: id: 8ad08ca797ef6ca50197f3cce6267991 status: Active version: 1 currency: USD startDate: '2020-01-01' endDate: '2020-12-31' amount: 100 orderNumber: O-0001 orderId: 00989e98483e00030a2733ee989e9815 accountId: 8a8aa0ac7f3b4c1d017f3b4c1d0a0001 accountNumber: ACC-0001 commitmentNumber: TW-0001 name: Example Commitment type: MinCommitment description: This a example commitment. priority: 1 eligibleAccountConditions: field: Account.AccountNumber operator: eq value: ACC-0001 conditions: - {} relation: and eligibleChargeConditions: field: RatePlanCharge.ChargeNumber operator: in value: C-0001,C-0002 conditions: - {} relation: and customFields: {} excludeItemBookingFromRevenueAccounting: true adjustmentLiabilityAccountingCode: Accounts Receivable adjustmentRevenueAccountingCode: Accounts Receivable contractAssetAccountingCode: Accounts Receivable contractLiabilityAccountingCode: Accounts Receivable contractRecognizedRevenueAccountingCode: Accounts Receivable deferredRevenueAccountingCode: Accounts Receivable excludeItemBillingFromRevenueAccounting: false isAllocationEligible: true isUnbilled: false recognizedRevenueAccountingCode: Accounts Receivable revenueRecognitionRule: Recognize upon invoicing unbilledReceivablesAccountingCode: Accounts Receivable revenueRecognitionTiming: Upon Order Activation Date revenueAmortizationMethod: string accountReceivableAccountingCode: Accounts Receivable taxable: true taxCode: SalesTax_US taxMode: TaxInclusive '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /v1/commitments/{commitment-key}/periods: get: tags: - Commitments summary: List periods for a commitment description: | Lists periods of the specified commitment. You can paginate the results using `page` and `pageSize` query parameters. operationId: getCommitmentPeriods parameters: - name: commitment-key in: path required: true description: The unique identifier or number of the commitment. schema: type: string - name: startDate in: query required: false description: Start date of the billing period in `YYYY-MM-DD` format. Date filters must be up to 5 years apart. schema: type: string format: date - name: endDate in: query required: false description: End date of the billing period in `YYYY-MM-DD` format. Date filters must be up to 5 years apart. schema: type: string format: date - name: accountNumber in: query required: false description: | Account number to which the commitment belongs to. schema: type: string - name: page in: query required: false description: | Page number for pagination. schema: type: integer minimum: 1 default: 1 - name: pageSize in: query required: false description: | Page size for pagination. schema: type: integer minimum: 1 maximum: 100 default: 20 - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListCommitmentPeriodsResponse' example: periods: - id: 0df89cf12e650006ac13624398764f1b commitmentId: 8ad08ca797ef6ca50197f3cce6267991 commitmentNumber: TW-0001 currency: USD priority: 1 version: 1 type: MinCommitment startDate: '2024-01-01' endDate: '2024-12-31' amount: 100 status: Active total: 1 page: 1 pageSize: 1 '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /v1/commitments/{commitmentId}/balance: get: tags: - Commitments summary: Retrieve the balance for a commitment description: | Retrieves the balance amount for a specific commitment for current and past periods. Future periods are not covered. operationId: getCommitmentBalance parameters: - name: commitmentId in: path required: true description: The unique identifier of the commitment. schema: type: string - name: page in: query required: false description: | Page number for pagination. schema: type: integer minimum: 1 default: 1 - name: pageSize in: query required: false description: | Page size for pagination. schema: type: integer minimum: 1 maximum: 100 default: 20 - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetCommitmentBalanceResponse' example: total: 1 page: 1 pageSize: 1 periods: - id: 6cf8cc0ddddc0061ac13d7a998bc18bb status: Active startDate: '2024-01-01' endDate: '2024-12-31' balance: 500 committedAmount: 1000 totalSpend: 500 '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /v1/adjustments: get: description: | Describes how to retrieve detailed information about delivery adjustments of a subscription. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. operationId: GET_Subscription_Adjustments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | A subscription number. in: query name: subscription-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: adjustments: - adjustmentId: 4028818886a2149b0186a237d0ff003b adjustmentNumber: ADJ-00000001 amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: CM00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Billed subscriptionNumber: A-S00000001 - adjustmentId: 4028818886a2149b0186a2404f67003c adjustmentNumber: ADJ-00000002 amount: -5 billingDate: '2023-02-27' chargeNumber: C-00000001 creditMemoNumber: CM00000002 debitMemoNumber: DM00000002 deferredRevenueAccountingCode: string deliveryDate: '2023-02-27' deliveryDay: monday reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Cancelled subscriptionNumber: A-S00000001 success: true schema: $ref: '#/components/schemas/GETAdjustmentsBySubscriptionNumberResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all delivery adjustments of a subscription tags: - Delivery Adjustments post: description: | Describes how to create one or more delivery adjustments for a subscription. **Notes**: - The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. - This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “success = true” as well as eligible delivery adjustments and ineligible delivery adjustments are returned in the response; only when no delivery adjustment is eligible, “success=false” is returned. operationId: Create_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateBillingAdjustmentRequestType' required: true responses: '200': content: application/json: examples: response: value: adjustments: - adjustmentId: 4028818886a2149b0186a237d0ff003b adjustmentNumber: ADJ-00000001 amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: CM00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday eligible: true reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Billed subscriptionNumber: A-S00000001 ineligibleAdjustments: - adjustmentId: null adjustmentNumber: null amount: null billingDate: null chargeNumber: C-00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-27' deliveryDay: monday eligible: false errorMessage: Subscription does not have a delivery scheduled for this day reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: null subscriptionNumber: A-S00000001 success: true totalAmount: -5 totalNumberOfDeliveries: 1 schema: $ref: '#/components/schemas/GETAdjustmentsResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/preview: post: description: | Describes how to preview delivery adjustments of a subscription. **Notes**: - The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. - This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “success = true” as well as eligible delivery adjustments and ineligible delivery adjustments are returned in the response; only when no delivery adjustment is eligible, “success=false” is returned. operationId: Preview_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPreviewBillingAdjustmentRequestType' required: true responses: '200': content: application/json: examples: response: value: adjustments: - adjustmentId: 'null' adjustmentNumber: 'null' amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: null deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday eligible: true reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: null subscriptionNumber: A-S00000001 ineligibleAdjustments: - adjustmentId: null adjustmentNumber: null amount: null billingDate: null chargeNumber: C-00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-27' deliveryDay: monday eligible: false errorMessage: Subscription does not have a delivery scheduled for this day reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: null subscriptionNumber: A-S00000001 success: true totalAmount: -5 totalNumberOfDeliveries: 1 schema: $ref: '#/components/schemas/GETAdjustmentsResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Preview a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/{adjustment-key}: get: description: | Describes how to retrieve detailed information about a delivery adjustment. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. operationId: GET_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The delivery adjustment ID or number to retrieve. in: path name: adjustment-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: adjustmentId: 4028818886a2149b0186a2404f67003c adjustmentNumber: ADJ-00000001 amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: CM00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Billed subscriptionNumber: A-S00000001 schema: $ref: '#/components/schemas/GETAdjustmentByIdResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/{adjustmentId}/cancel: put: description: | Describes how to cancel an unbilled delivery adjustment. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. operationId: PUT_CancelAdjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID of the delivery adjustment to cancel. in: path name: adjustmentId required: true schema: format: UUID type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelBillingAdjustmentRequest' required: true responses: '200': content: application/json: examples: response: value: debitMemoNumber: DM00000001 success: true schema: $ref: '#/components/schemas/GETCancelAdjustmentResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a delivery adjustment tags: - Delivery Adjustments /v1/billing-documents: get: description: | Retrieves the information about all billing documents associated with a specified account. The billing documents contain invoices, credit memos, and debit memos. To retrieve information about credit memos and debit memos, you must have the Invoice Settlement feature enabled. You can use query parameters to restrict the data returned in the response. Examples: - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&sort=+documentDate - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&status=Posted - /billing-documents?accountNumber=A00000001&sort=+documentDate - /billing-documents?accountNumber=A00000001&status=Posted operationId: GET_BillingDocuments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The ID of the customer account that the billing documents are associated with. **Note**: When retrieving information about all billing documents associated with an account, you must specify either `accountId` or `accountNumber` in the query parameters. in: query name: accountId required: false schema: format: uuid type: string - description: | The number of the customer account that the billing documents are associated with. **Note**: When retrieving information about all billing documents associated with an account, you must specify either `accountId` or `accountNumber` in the query parameters. in: query name: accountNumber required: false schema: format: uuid type: string - description: | The date of the billing document. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. in: query name: documentDate required: false schema: format: date type: string - description: | The status of the billing document. in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error type: string - description: | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. If you do not specify any sortable field, the response data is sorted by the `documentDate` field in descending order. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - documentDate - documentType Examples: - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1 &sort=+documentDate,-documentType - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1 &status=Posted&sort=+documentDate&page=2&pageSize=15 in: query name: sort required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: documents: - accountId: 4028905f5e4feb38bbb50af9aa002d1 accountNumber: A00000001 amount: 100 balance: 90 documentDate: '2017-10-01' documentNumber: INV-0000001 documentType: Invoice id: 4028905f5e4jjj015e50af9aa002d1 status: Posted currency: USD - accountId: 4028905f5e4feb38b111b50af9aa002d1 accountNumber: A00000001 amount: 100 balance: 90 documentDate: '2017-09-01' documentNumber: CM-0000001 documentType: CreditMemo id: 4028905f5e4jbbb015e50af9aa002d1 status: Posted currency: USD - accountId: 4028905f5e4feb3833b50af9aa002d1 accountNumber: A00000001 amount: 100 balance: 90 documentDate: '2017-07-01' documentNumber: DM-0000001 documentType: DebitMemo id: 4028905f5e4jccc015e50af9aa002d1 status: Posted currency: USD success: true schema: $ref: '#/components/schemas/BillingDocumentQueryResponseElementType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List billing documents for an account tags: - Billing Documents x-code-samples: - label: Curl lang: curl source: | curl -X GET -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type: application/json" "https://rest.sandbox.eu.zuora.com/v1/billing-documents?accountId=402892c74c9193cd014c91d35b0a0132" /v1/accounts/billing-documents/files/deletion-jobs: post: description: | Creates an asynchronous job to permanently delete all billing document PDF files for specific accounts. After the deletion job is completed, all billing document PDF files are permanently deleted. To retrieve the status of a deletion job, call [Retrieve a job of hard deleting billing document files](https://developer.zuora.com/api-references/api/operation/GET_BillingDocumentFilesDeletionJob). **Note**: This operation can be used only if you have the Billing user permission "Hard Delete Billing Document Files" enabled. operationId: POST_BillingDocumentFilesDeletionJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBillingDocumentFilesDeletionJobRequest' required: true responses: '200': content: application/json: examples: response: value: id: 2c92c8f83dc4f752013dc72c24ee016c status: Pending success: true schema: $ref: '#/components/schemas/POSTBillingDocumentFilesDeletionJobResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a job to hard delete billing document files tags: - Billing Documents /v1/accounts/billing-documents/files/deletion-jobs/{jobId}: get: description: | Retrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts. **Note**: This operation can be used only if you have the Billing user permission "Hard Delete Billing Document Files" enabled. operationId: GET_BillingDocumentFilesDeletionJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c. in: path name: jobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: id: 2c92c8f83dc4f752013dc72c24ee016c status: Pending success: true schema: $ref: '#/components/schemas/GETBillingDocumentFilesDeletionJobResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a job of hard deleting billing document files tags: - Billing Documents /v1/accounts/{key}/billing-documents/generate: post: description: | Generates draft or posted billing documents for a specified account. You can also generate billing documents for specified subscriptions of a specified account. The billing documents contain invoices and credit memos. To generate credit memos, you must have the Invoice Settlement feature enabled. **Note**: You cannot generate billing documents for cancelled or suspended subscriptions. operationId: POST_GenerateBillingDocuments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419 or AC0000001. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostGenerateBillingDocumentType' required: true responses: '200': content: application/json: examples: response: value: invoices: - id: 8ad084db909fae930190a121c84957ff creditMemos: [] success: true schema: $ref: '#/components/schemas/GenerateBillingDocumentResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate billing documents by account ID tags: - Billing Documents /v1/invoices: post: description: | Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers. To use this operation, you must have the **Modify Invoice** and at least one of the **Create Standalone Invoice With Product Catalog** or **Create Standalone Invoice Without Product Catalog** user permissions. See Billing Roles for more information. operationId: POST_StandaloneInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostInvoiceType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad084db909fae930190a121c84957ff invoiceNumber: INV00000155 accountId: 8ad09be48db5aba7018db604776d4854 amount: 100 amountWithoutTax: 100 discount: 0 invoiceDate: '2024-07-30' dueDate: '2024-08-29' autoPay: false comments: null status: Draft taxAmount: 0 taxExemptAmount: 0 transferredToAccounting: null sourceType: Standalone billToContactId: null soldToContactId: null templateId: null paymentTerm: null sequenceSetId: null adjustmentAmount: 0 balance: 100 billToContactSnapshotId: null creditMemoAmount: 0 includesOneTime: true includesRecurring: true includesUsage: true lastEmailSentDate: null paymentAmount: 0 postedBy: null postedDate: null refundAmount: 0 soldToContactSnapshotId: null source: API sourceId: null targetDate: null taxMessage: null taxStatus: Complete createdById: b243314d594646d3b2651aeedd4be47e createdDate: '2024-07-11 02:31:04' updatedById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-07-11 02:31:04' billRunId: null currency: USD invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/PostInvoiceResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a standalone invoice tags: - Invoices put: description: | Updates multiple invoices in batches with one call. The following tutorials demonstrate how to use this operation: - Add and delete invoice items of draft standalone invoices - Edit due dates of draft standalone invoices - Edit invoice item prices and custom fields of draft standalone invoices ### Limitations - You can update a maximum of 50 invoices by one call. operationId: PUT_BatchUpdateInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutBatchInvoiceType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update invoices tags: - Invoices /v1/invoices/batch: post: description: | Creates multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers. To use this operation, you must have the **Modify Invoice** and at least one of the **Create Standalone Invoice With Product Catalog** or **Create Standalone Invoice Without Product Catalog** user permissions. See Billing Roles for more information. ### Limitations This operation has the following limitations: * You can create a maximum of 50 invoices in one request. * You can create a maximum of 1,000 invoice items in one request. operationId: POST_StandaloneInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostBatchInvoicesType' required: true responses: '200': content: application/json: examples: response: value: invoices: - IntegrationId__NS: string IntegrationStatus__NS: string SyncDate__NS: string accountId: 4028818484f483d20184f4f7efc40001 adjustmentAmount: 0 amount: 700 amountWithoutTax: 700 autoPay: true balance: 700 billRunId: 4028818484f483d20184f50064950035 billToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 comments: '' complexity__c: Middle createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2022-12-08 19:49:16' currency: USD description__c: description discount: 0 dueDate: '2022-11-30' id: 4028818484f483d20184f5006b97003f includesOneTime: true includesRecurring: true includesUsage: true invoiceDate: '2022-10-31' invoiceGroupNumber: N-0001 invoiceNumber: INV00000001 lastEmailSentDate: '2022-12-08 19:51:16' paymentAmount: 0 postedBy: 402881e522cf4f9b0122cf5d82860002 postedDate: '2022-12-09' refundAmount: 0 sequenceSetId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860005 source: BillRun sourceId: BR-00000001 sourceType: Subscription status: Posted success: true targetDate: '2022-10-31' transferredToAccounting: string updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2022-12-08 19:51:23' - objectIndex: 1 processId: CA037C0B8C5B0682 reasons: - code: 58490020 message: No account is found with accountId ff8080817cda56fa017cda87aaa2071f. success: false success: true schema: $ref: '#/components/schemas/PostBatchInvoiceResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create standalone invoices tags: - Invoices /v1/invoices/bulk-post: post: description: | Posts multiple invoices. You can post a maximum of 50 invoices in one single request. Additionally, you can also update invoice dates while posting the invoices. **Note** : This operation is synchronous and invoices within the bulk request are posted one by one. The maximum batch size depends on the posting performance, which varies with invoice complexity and integrations with external tax engines. operationId: POST_PostInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTInvoicesBatchPostType' required: true responses: '200': content: application/json: examples: response: value: invoices: - id: 402890555a7e9791015a7f15fe440123 success: true - id: 402890555a7e9791015a7f15fe44013a success: true - id: ff808081804f25b001804f2d8971079f processId: F3D4DAF98E6CE569 reasons: - code: 59210020 message: Only invoices with Draft status can be posted. success: false success: true schema: $ref: '#/components/schemas/InvoicesBatchPostResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Post invoices tags: - Invoices /v1/invoices/pdf-status: get: description: 'Retrieves the PDF generation statuses of a batch of invoices. ' operationId: GetInvoicePdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: The IDs or numbers of the invoices separated by commas. For example - `?invoiceKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,INV-0000001`. A maximum of 50 keys can be entered in this field. in: query name: invoiceKeys required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: example: invoiceFiles: - invoiceId: 402824aa8cc894d5018cc8a120576881 invoiceNumber: INV00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - invoiceId: 2c98908a904dfc2601904e6e14090241 invoiceNumber: INV00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - invoiceId: 513935bb9dd905e6129dd9b231687992 invoiceNumber: INV00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true schema: $ref: '#/components/schemas/GetInvoicePdfStatusBatchResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: example: processId: processId reasons: - code: '50000020' message: Credit memo key is required success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Forbidden headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve the PDF file generation status of invoices tags: - Invoices x-accepts: application/json /v1/invoices/{invoiceKey}: delete: description: | Deletes a specific invoice. Whether to delete an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 100 items, the invoice is deleted synchronously. Otherwise, the invoice is deleted asynchronously. If you want to change the threshold, submit a request at Zuora Global Support. operationId: DELETE_DeleteInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: id: 40288ae9600808280160081dc9c13f15 jobId: 40288ae9600808280160081db1533506 jobStatus: Completed success: true schema: $ref: '#/components/schemas/DeleteInvoiceResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an invoice tags: - Invoices get: description: | Retrieves a specific invoice. operationId: Get_GetInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: IntegrationId__NS: string IntegrationStatus__NS: string SyncDate__NS: string accountId: 4028818484f483d20184f4f7efc40001 adjustmentAmount: 0 amount: 700 amountWithoutTax: 700 autoPay: true balance: 700 billRunId: 4028818484f483d20184f50064950035 billToContactSnapshotId: 402881e522cf4f9b0122cf5d82860010 comments: '' complexity__c: Middle createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2022-12-08 19:49:16' currency: USD description__c: description discount: 0 dueDate: '2022-11-30' id: 4028818484f483d20184f5006b97003f includesOneTime: true includesRecurring: true includesUsage: true invoiceDate: '2022-10-31' invoiceGroupNumber: N-0001 invoiceNumber: INV00000001 lastEmailSentDate: '2022-12-08 19:51:16' paymentAmount: 0 postedBy: 402881e522cf4f9b0122cf5d82860002 postedDate: '2022-12-09' refundAmount: 0 sequenceSetId: 402881e522cf4f9b0122cf5d82860009 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860011 source: BillRun sourceId: BR-00000001 sourceType: Subscription status: Posted success: true targetDate: '2022-10-31' transferredToAccounting: string updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2022-12-08 19:51:23' schema: $ref: '#/components/schemas/PostInvoiceResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an invoice tags: - Invoices put: description: | Updates a specific invoice. The following tutorials demonstrate how to use this operation: - Add and delete invoice items of draft standalone invoices - Edit due dates of draft standalone invoices - Edit invoice item prices and custom fields of draft standalone invoices operationId: PUT_UpdateInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutInvoiceType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad084db909fae930190a121c84957ff number: INV00000155 accountId: 8ad09be48db5aba7018db604776d4854 invoiceDate: '2024-07-30' currency: USD targetDate: null dueDate: '2024-08-29' postedOn: null postedById: null status: Draft amount: 105 taxAmount: 0 totalTaxExemptAmount: 0 balance: 105 discount: 0 comment: null autoPay: false transferredToAccounting: false creditBalanceAdjustmentAmount: 0 createdDate: '2024-07-11 02:31:04' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-07-11 02:43:45' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null success: true schema: $ref: '#/components/schemas/PutInvoiceResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an invoice tags: - Invoices /v1/invoices/{invoiceKey}/application-parts: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. If you are in Zuora version 341, this operation will return only processed payments applied to the invoices. If you are in the Zuora version less than 341, this operation behavior remains the same and returns all payments associated with the invoice regardless of the payment status. Retrieves information about the payments or credit memos that are applied to a specified invoice. operationId: GET_InvoiceApplicationParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: applicationParts: - appliedAmount: 22 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:42:16' creditMemoId: 4028905f60a165a50160b4f632ff023d paymentId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:42:16' - appliedAmount: 11 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:41:38' creditMemoId: null paymentId: 4028905f60a165a50160b4f5d5cb0229 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:41:38' success: true schema: $ref: '#/components/schemas/GetInvoiceApplicationPartCollectionType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all application parts of an invoice tags: - Invoices /v1/invoices/{invoiceKey}/emails: post: description: | Sends a posted invoice to the specified email addresses manually. ### Notes - You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information. - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Invoice Posted Default Email Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. - The invoices are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met: * The `useEmailTemplateSetting` field is set to `false`. * The email addresses are not specified in the `emailAddresses` field. operationId: POST_EmailInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostInvoiceEmailRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Email an invoice tags: - Invoices /v1/invoices/{invoiceKey}/files: get: description: | Retrieves the information about all PDF files of a specified invoice. Invoice PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response. You can use the [Query](https://developer.zuora.com/api-references/api/operation/Action_POSTquery) action to get the latest PDF file, for example: `"select Body from Invoice where Id = '2c93808457d787030157e0324aea5158'"`. See [Query an Invoice Body](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/Invoice/Query_an_Invoice_Body_Field) for more information. operationId: GET_InvoiceFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: invoiceFiles: - id: 2c98901f62d7d83d0162d7facec2262f pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d versionNumber: 1524041954479 - id: 2c98901f62d7d83d0162d7f4a9792629 pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7f4a95c2627 versionNumber: 1524041551946 - id: 2c98901f62d7d83d0162d7f491ea2626 pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7f490f22624 versionNumber: 1524041544112 success: true schema: $ref: '#/components/schemas/GETInvoiceFilesResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all files of an invoice tags: - Invoices post: description: | Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status. To use this operation, you must enable the Modify Invoice permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one invoice. - Ensure that each uploaded PDF file has a unique name. Duplicate filenames are not allowed when attaching files to an invoice. operationId: POST_UploadFileForInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: description: | The PDF file to upload for the invoice. format: binary type: string type: object responses: '200': content: application/json: examples: response: value: fileId: 40289f466463d683016463ef8b7301a2 success: true schema: $ref: '#/components/schemas/POSTUploadFileResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a file for an invoice tags: - Invoices x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@InvoiceFile.pdf" "https://rest.zuora.com/v1/invoices/2c92c8955bd63cc1015bd7c151af02ab/files" /v1/invoices/{invoiceKey}/items: get: description: | Retrieves the information about all items of a specified invoice. operationId: GET_InvoiceItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: invoiceItems: - appliedToItemId: null balance: 21.1 chargeAmount: 21.1 chargeDate: '2015-11-20 19:53:00' chargeDescription: '' chargeId: 2c92c0f9511f56b2015126814af832d2 chargeName: Annual Fee chargeType: Recurring description: '' commitmentId: 4028819f9a4dfdf1019a4e04acfb7e63 commitmentPeriodId: 4028819f9a4dfdf1019a4e06f04a402c excludeItemBillingFromRevenueAccounting: true id: 2c92c095511f5b4401512682dd017989 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge productName: TeamCollab Enterprise quantity: 1 serviceEndDate: '2015-11-30' serviceStartDate: '2015-11-20' soldToContactId: 2c92c0f9511f56b2015126814ad532cd soldToContactSnapshotId: 2c92c0f9511f56b2015126814ad532cd sourceItemType: SubscriptionComponent subscriptionId: 2c92c0f9511f56b2015126814ad532cc subscriptionName: A-S00000004 taxAmount: 0 taxationItems: data: - balance: 2.11 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce6eeb0ffe jurisdiction: County locationCode: 000-1 name: taxName paymentAmount: 0 taxAmount: 2.11 taxCode: TAXCODE-1 taxCodeDescription: null taxDate: '2015-11-20' taxRate: 0.1 taxRateDescription: '' taxRateType: Percentage unitOfMeasure: '' unitPrice: 21.1 - appliedToItemId: 2c92c095511f5b4401512682dd017989 chargeAmount: -2.1 chargeDate: '2015-11-20 19:53:00' chargeDescription: '' chargeId: 1b3dede652fa47db833a83be55d850a5 chargeName: Discount chargeType: OneTime description: '' commitmentId: 4028819f9a4dfdf1019a4e04acfb7e63 commitmentPeriodId: 4028819f9a4dfdf1019a4e06f04a402c excludeItemBillingFromRevenueAccounting: true id: 3e28d61d442f433797e268e2b7c11eeb invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Discount productName: TeamCollab Enterprise quantity: 0 serviceEndDate: '2015-11-30' serviceStartDate: '2015-11-20' soldToContactId: 2c92c0f9511f56b2015126814ad532cd soldToContactSnapshotId: 2c92c0f9511f56b2015126814ad532cd sourceItemType: SubscriptionComponent subscriptionId: c2d9a5768db440cbbf2709a55c614bed subscriptionName: A-S00000004 taxAmount: 0 taxationItems: data: - balance: 0.21 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce6eeb0ffe jurisdiction: County locationCode: 000-1 name: taxName paymentAmount: 0 taxAmount: 0.21 taxCode: TAXCODE-1 taxCodeDescription: null taxDate: '2015-11-20' taxRate: 0.1 taxRateDescription: '' taxRateType: Percentage unitOfMeasure: '' unitPrice: 10 success: true schema: $ref: '#/components/schemas/GETInvoiceItemsResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all items of an invoice tags: - Invoices /v1/invoices/{invoiceKey}/items/{itemId}/taxation-items: get: description: | Retrieves information about the taxation items of a specific invoice item. operationId: GET_TaxationItemsOfInvoiceItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string - description: | The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef. in: path name: itemId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: data: - balance: 10 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce84e3102c jurisdiction: test locationCode: code - 001 name: test paymentAmount: 0 taxAmount: 10 taxCode: taxcode taxCodeDescription: description taxDate: '2019-02-18' taxRate: 2 taxRateDescription: test taxRateType: FlatFee - balance: 10 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce85d6102e jurisdiction: test locationCode: code - 001 name: test paymentAmount: 0 taxAmount: 10 taxCode: taxcode taxCodeDescription: description taxDate: '2019-02-18' taxRate: 2 taxRateDescription: test taxRateType: FlatFee success: true schema: $ref: '#/components/schemas/GETInvoiceTaxationItemsResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all taxation items of an invoice item tags: - Invoices /v1/invoices/{invoiceKey}/reverse: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Reverses a posted invoice. The reversal operation is performed asynchronously when the invoice contains more than 2,000 items in total. **Restrictions** You are not allowed to reverse an invoice if any of the following restrictions is met: * Payments and credit memos are applied to the invoice. * The invoice is split. * The invoice is not in Posted status. * The total amount of the invoice is less than 0 (a negative invoice). * Using Tax Connector for Extension Platform to calculate taxes. * An invoice contains more than 50,000 items in total, including invoice items, discount items, and taxation items. See [Invoice Reversal](https://knowledgecenter.zuora.com/CB_Billing/IA_Invoices/Reverse_Posted_Invoices) for more information. operationId: PUT_ReverseInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutReverseInvoiceType' required: true responses: '200': content: application/json: examples: response: value: creditMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PutReverseInvoiceResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Reverse an invoice tags: - Invoices /v1/invoices/{invoiceKey}/taxation-items: post: description: | Creates taxation items for an invoice. operationId: POST_INV_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemList' required: true responses: '200': content: application/json: examples: response: value: success: true taxationItems: - createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:08:43' exemptAmount: 0 financeInformation: accountsReceivableAccountingCode: Check accountsReceivableAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a7e9791015a87a072880062 invoiceItemId: 402890555a7e9791015a879f064d0055 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX taxAmount: 0.1 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-09-30' taxMode: TaxExclusive taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' schema: $ref: '#/components/schemas/GETTaxationItemListType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create taxation items for an invoice tags: - Invoices /v1/invoices/{invoiceKey}/write-off: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Writes off a posted invoice. By writing off an invoice, a credit memo is created and applied to the invoice. The generated credit memo items and credit memo taxation items are applied to invoice items and invoice taxation items based on the configured default application rule. If an invoice is written off, the balance of each invoice item and invoice taxation item must be zero. If you set the **Create credit memos mirroring invoice items billing rule** to **Yes**, you can write off an invoice even if all its items have zero balance. **Restrictions**: You cannot write off an invoice if any of the following restrictions is met: * The balance of an invoice has been changed before Invoice Settlement is enabled. For example, before Invoice Settlement is enabled, any credit balance adjustments, invoice item adjustments, or invoice adjustments have been applied to an invoice. * An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items. See [Invoice Write-off](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Invoice_Write-Off) for more information. operationId: PUT_WriteOffInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTWriteOffInvoiceRequest' required: true responses: '200': content: application/json: examples: response: value: creditMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PUTWriteOffInvoiceResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Write off an invoice tags: - Invoices /v1/credit-memos: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all credit memos. For a use case of this operation, see [Get credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo). ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. Examples: - /v1/credit-memos?status=Posted - /v1/credit-memos?referredInvoiceId=null&status=Draft - /v1/credit-memos?status=Posted&type=External&sort=+number operationId: GET_CreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | This parameter filters the response based on the `accountId` field. in: query name: accountId required: false schema: type: string - description: | This parameter filters the response based on the `accountNumber` field. in: query name: accountNumber required: false schema: type: string - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `appliedAmount` field. in: query name: appliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `autoApplyUponPosting` field. in: query name: autoApplyUponPosting required: false schema: type: boolean - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `creditMemoDate` field. in: query name: creditMemoDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `currency` field. in: query name: currency required: false schema: type: string - description: | This parameter filters the response based on the `excludeFromAutoApplyRules` field. in: query name: excludeFromAutoApplyRules required: false schema: type: boolean - description: | This parameter filters the response based on the `number` field. in: query name: number required: false schema: type: string - description: | This parameter filters the response based on the `referredInvoiceId` field. in: query name: referredInvoiceId required: false schema: type: string - description: | This parameter filters the response based on the `refundAmount` field. in: query name: refundAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `sourceId` field. in: query name: sourceId required: false schema: type: string - description: | This parameter filters the response based on the `status` field. in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string - description: | This parameter filters the response based on the `targetDate` field. in: query name: targetDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `taxAmount` field. in: query name: taxAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `totalTaxExemptAmount` field. in: query name: totalTaxExemptAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `transferredToAccounting` field. in: query name: transferredToAccounting required: false schema: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string - description: | This parameter filters the response based on the `unappliedAmount` field. in: query name: unappliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - description: | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by credit memo number. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - accountId - amount - appliedAmount - createdById - createdDate - creditMemoDate - number - referredInvoiceId - refundAmount - status - targetDate - taxAmount - totalTaxExemptAmount - transferredToAccounting - unappliedAmount - updatedDate Examples: - /v1/credit-memos?sort=+number - /v1/credit-memos?status=Processed&sort=-number,+amount in: query name: sort required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: creditmemos: - accountId: 2c92c8f95bd63b98015bd7ab09ef0926 accountNumber: A00000001 amount: 23 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 2c92c8f95b79c9ad015b80614273052c createdDate: '2017-05-05 01:39:30' creditMemoDate: '2017-05-05' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 2c92c8f95bd63b94015bd7c39289112e invoiceGroupNumber: N-0001 latestPDFFileId: 2c92c8955bd63b6c015bd7c395e90023 number: CM00000002 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: null refundAmount: 0 reversed: false sequenceSetId: null source: BillRun sourceId: BR-00000024 sourceType: Standalone status: Draft targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 23 updatedById: 2c92c8f95b79c9ad015b80614273052c updatedDate: '2017-05-05 01:39:30' - accountId: 2c92c8f95bd63b98015bd7ab09ef0926 accountNumber: A00000001 amount: 10 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 2c92c8f95b79c9ad015b80614273052c createdDate: '2017-05-05 01:15:23' creditMemoDate: '2017-05-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 2c92c8f95bd63b9d015bd7ad7fe206f9 invoiceGroupNumber: N-0001 latestPDFFileId: 2c92c8955bd63b6c015bd7ad8921001d number: CM00000001 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: 2c92c8955bd63cc1015bd7c151af02ab refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromInvoice sourceId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 10 updatedById: 2c92c8f95b79c9ad015b80614273052c updatedDate: '2017-05-05 01:15:24' success: true schema: $ref: '#/components/schemas/GETCreditMemoCollectionType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List credit memos tags: - Credit Memos post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates an ad-hoc credit memo from a product rate plan charge. Zuora supports the creation of credit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models. When credit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency. You can create a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: POST_CreditMemoFromPrpc parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditMemoFromChargeRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8ad08f0091698a7a01916e70df165b3b number: CM00000010 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 currency: USD creditMemoDate: '2024-08-19' targetDate: null postedById: null postedOn: null status: Draft amount: 10 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 10 refundAmount: 0 appliedAmount: 0 comment: null source: AdhocFromPrpc sourceId: null referredInvoiceId: null reasonCode: Correcting invoice error createdDate: '2024-08-19 23:19:36' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-08-19 23:19:36' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null latestPDFFileId: ac1ebc24569sd transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a credit memo from a charge tags: - Credit Memos /v1/credit-memos/bulk: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates multiple credit memos from invoices or product rate plan charges. You can create a maximum of 50 credit memos in one single request. - If you set the `sourceType` request field to `Invoice`, you can create multiple credit memos from invoices. - If you set the `sourceType` request field to `Standalone`, you can create multiple credit memos from product rate plan charges. The credit memos that are created are each in separate database transactions. If the creation of one credit memo fails, other credit memos can still be created successfully. You can create credit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. Zero-amount memo items are supported in the following scenarios: - If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero. - If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice. operationId: POST_CreateCreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkCreditMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: ff8080817fe9d7b9017fe9e5234d04cb accountNumber: A00000001 amount: 100 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: test createdById: ff8080817fe9d7b9017fe9e41732030e createdDate: '2022-04-02 18:49:47' creditMemoDate: '2022-04-02' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: ff8080817fe9d7b9017fe9e5382f04f5 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: CM00000001 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0 refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromInvoice sourceId: null sourceType: Invoice status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 100 updatedById: ff8080817fe9d7b9017fe9e41732030e updatedDate: '2022-04-02 18:49:47' - objectIndex: 1 processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id test. success: false success: true schema: $ref: '#/components/schemas/BulkCreditMemosResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create credit memos tags: - Credit Memos put: description: | **Notes:** - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. - You can update credit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. Updates the basic and finance information about multiple credit memos. You can update a maximum of 50 credit memos in one single request. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The Edit credit and debit memos tutorial demonstrates how to use this operation to add and delete memo items. The credit memos that are updated are each in separate database transactions. If the update of one credit memo fails, other credit memos can still be updated successfully. operationId: PUT_UpdateCreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBulkCreditMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: ff8080817fe9d7b9017fe9e5234d04cb accountNumber: A00000001 amount: 100 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: test createdById: ff8080817fe9d7b9017fe9e41732030e createdDate: '2022-04-02 18:49:47' creditMemoDate: '2022-04-02' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: ff8080817fe9d7b9017fe9e5382f04f5 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: CM00000001 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0 refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromInvoice sourceId: null sourceType: Invoice status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 100 updatedById: ff8080817fe9d7b9017fe9e41732030e updatedDate: '2022-04-02 18:49:47' - id: ff8080817fe9d7b9017fe9e41732030f objectIndex: 1 processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id. success: false success: true schema: $ref: '#/components/schemas/BulkCreditMemosResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update credit memos tags: - Credit Memos /v1/credit-memos/pdf-status: get: description: | Retrieves the PDF generation statuses of a batch of credit memos. operationId: Get_CreditMemoPdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: 'The IDs or numbers of the credit memos separated by commas. For example - `?creditMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,CM0000001`. A maximum of 50 keys can be entered in this field. ' in: query name: creditMemoKeys required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: example: creditMemoFiles: - creditMemoId: 402824aa8cc894d5018cc8a120576881 creditMemoNumber: CM00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - creditMemoId: 2c98908a904dfc2601904e6e14090241 creditMemoNumber: CM00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - creditMemoId: 514936bb7dd014e6230dd0c342798103 creditMemoNumber: CM00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true schema: $ref: '#/components/schemas/GetCreditMemoPdfStatusBatchResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: example: processId: processId reasons: - code: '50000020' message: Credit memo key is required success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Forbidden headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve the PDF file generation status of credit memos tags: - Credit Memos x-accepts: application/json /v1/credit-memos/{creditMemoId}/items/{cmitemid}/taxation-items: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about the taxation items of a specific credit memo item. operationId: GET_TaxationItemsOfCreditMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems). in: path name: cmitemid required: true schema: type: string - description: | The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: data: - appliedAmount: 0 exemptAmount: 10 financeInformation: onAccountAccountingCode: Check onAccountAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 2c98901a68ff2680016903216a271a67 jurisdiction: Jurisdiction locationCode: '8' name: taxName_0 refundAmount: 0 sourceTaxItemId: null taxAmount: 10 taxCode: taxCode taxCodeDescription: taxCodeDescription taxDate: '2016-10-10' taxRate: 0.1 taxRateDescription: taxRateDescription taxRateType: Percentage unappliedAmount: 10 success: true schema: $ref: '#/components/schemas/GETTaxationItemsOfCreditMemoItemType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all taxation items of a credit memo item tags: - Credit Memos /v1/credit-memos/{creditMemoId}/write-off: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Write off a fully unapplied credit memo. When writing off a credit memo, a debit memo is automatically created, and then the credit memo to be written off is fully applied to the debit memo. Note that this operation only supports writing off credit memos that are fully unapplied. Credit memos that are not fully unapplied cannot be written off by this operation. operationId: PUT_WriteOffCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTCreditMemoWriteOff' required: true responses: '200': content: application/json: examples: response: value: debitMemo: id: 4028905f5a87c0ff015a87e49e6b0062 success: true schema: $ref: '#/components/schemas/PUTCreditMemoWriteOffResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Write off a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}: delete: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Deletes a credit memo. Only credit memos with the Cancelled status can be deleted. You can delete a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: DELETE_CreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a credit memo tags: - Credit Memos get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific credit memo. For a use case of this operation, see [Get credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo). operationId: GET_CreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 3.1 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditMemoDate: '2017-03-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 402890555a7e9791015a879f064a0054 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a7e9791015a879f07fb005e number: CM00000012 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: 402890555a7e9791015a7f1756aa0035 refundAmount: 0 reversed: false sequenceSetId: null source: API sourceId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0.1 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 3.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a credit memo tags: - Credit Memos put: description: | **Notes:** - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. - You can update a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. Updates the basic and finance information about a credit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The [Edit credit and debit memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API) tutorial demonstrates how to use this operation to add and delete memo items. operationId: PUT_UpdateCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad081dd91698b2801916e637b19583f number: CM00000008 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 currency: USD creditMemoDate: '2024-08-19' targetDate: null postedById: null postedOn: null status: Draft amount: 14.99 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 14.99 refundAmount: 0 appliedAmount: 0 comment: Details about this Credit Memo source: AdhocFromPrpc sourceId: null referredInvoiceId: null reasonCode: Ad hoc credit createdDate: '2024-08-19 23:04:59' createdById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-19 23:05:55' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null latestPDFFileId: ac1ebc24569sd transferredToAccounting: 'No' excludeFromAutoApplyRules: true autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/apply: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Applies a posted credit memo to one or more invoices and debit memos. You can apply a credit memo to an invoice or a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. When you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 15,000. If the limit is hit, you can follow the following instructions: - If you want to apply one credit memo to multiple invoices or debit memos, decrease the number of invoices or debit memos in the request. - If you want to apply one credit memo to a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000. - If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000. If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000: (number of invoice items + number of debit memo items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule. operationId: PUT_ApplyCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad081dd91698b2801916e5a84b65653 number: CM00000007 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 currency: USD creditMemoDate: '2024-08-19' targetDate: null postedById: 8ad09fc28193c189018194da28be74ba postedOn: '2024-08-19 22:55:11' status: Posted amount: 14.99 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 3.99 refundAmount: 0 appliedAmount: 11 comment: '' source: AdhocFromPrpc sourceId: null referredInvoiceId: null reasonCode: Ad hoc credit createdDate: '2024-08-19 22:55:11' createdById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-19 22:59:54' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null latestPDFFileId: ac1ebc24569sd transferredToAccounting: 'No' excludeFromAutoApplyRules: true autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Apply a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/cancel: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Cancels a credit memo. Only credit memos with the Draft status can be cancelled. You can cancel a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: PUT_CancelCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 2020 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: '2017-09-03 19:59:07' comment: the comment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 15:31:10' creditMemoDate: '2017-10-17' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 402890555a87d7f5015a88c7a6830022 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a87d7f5015a88c7a7a2002a number: CM00000015 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: null refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromPrpc sourceId: null sourceType: Standalone status: Canceled success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 2020 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 15:36:57' schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/emails: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Sends a posted credit memo to the specified email addresses manually. ### Notes - You must activate the **Email Credit Memo | Manually email Credit Memo** notification before emailing credit memos. To include the credit memo PDF in the email, select the **Include Credit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information. - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Credit Memo Default Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. - The credit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met: * The `useEmailTemplateSetting` field is set to `false`. * The email addresses are not specified in the `emailAddresses` field. operationId: POST_EmailCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostCreditMemoEmailRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Email a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/files: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Uploads an externally generated PDF file for a credit memo that is in Draft or Posted status. To use this operation, you must enable the Modify Modify Credit Memo permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one credit memo. operationId: POST_UploadFileForCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: description: | The PDF file to upload for the credit memo. format: binary type: string type: object responses: '200': content: application/json: examples: response: value: fileId: 40289f466463d683016463ef8b7301a4 success: true schema: $ref: '#/components/schemas/POSTUploadFileResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a file for a credit memo tags: - Credit Memos x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@CreditMemoFile.pdf" "https://rest.zuora.com/v1/credit-memos/402890555a7e9791015a879f064a0054/files" get: description: | Retrieves the information about all PDF files of a specified credit memo. Credit Memo PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response. operationId: GET_CreditMemoFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: creditMemoFiles: - id: 8a90a24f8e128020018e12cf610f03f9 pdfFileUrl: /v1/files/8a90a24f8e128020018e12cf610903f8 versionNumber: 1709712563443 - id: 8a90b5148c6d127b018c6d1e3c6e022e pdfFileUrl: /v1/files/8a90b5148c6d127b018c6d1e3c68022d versionNumber: 1702637739555 success: true schema: $ref: '#/components/schemas/GETCreditMemoFilesResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all files of a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/items: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all items of a credit memo. A credit memo item is a single line item in a credit memo. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. Examples: - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100 - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate operationId: GET_CreditMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `appliedAmount` field. in: query name: appliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `id` field. in: query name: id required: false schema: type: string - description: | This parameter filters the response based on the `refundAmount` field. in: query name: refundAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `serviceEndDate` field. in: query name: serviceEndDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `serviceStartDate` field. in: query name: serviceStartDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `sku` field. in: query name: sku required: false schema: type: string - description: | This parameter filters the response based on the `skuName` field. in: query name: skuName required: false schema: type: string - description: | This parameter filters the response based on the `sourceItemId` field. in: query name: sourceItemId required: false schema: type: string - description: | This parameter filters the response based on the `subscriptionId` field. in: query name: subscriptionId required: false schema: type: string - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - description: | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by updated date. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - amount - appliedAmount - createdById - createdDate - id - refundAmount - serviceEndDate - serviceStartDate - sku - skuName - sourceItemId - subscriptionId - updatedById - updatedDate Examples: - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate in: query name: sort required: false schema: type: string responses: '200': content: application/json: examples: response: value: items: - amount: 1 amountWithoutTax: 0 appliedAmount: 0 appliedToItemId: null comment: '' commitmentId: 4028819f9a4dfdf1019a4e04acfb7e63 commitmentPeriodId: 4028819f9a4dfdf1019a4e06f04a402c createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditFromItemId: 402880e97a56f30b017a574012e50085 creditFromItemSource: CreditMemoItem excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: null deferredRevenueAccountingCodeType: null onAccountAccountingCode: null onAccountAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null id: 402890555a7e9791015a879f064d0055 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge quantity: 1 refundAmount: 0 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000001 skuName: New Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7e9791015a7f1756bc0037 sourceItemType: InvoiceDetail subscriptionId: 402890d25bec1155015bec35cc7c0bc7 taxMode: TaxExclusive taxationItems: data: - appliedAmount: 0 exemptAmount: 0 financeInformation: onAccountAccountingCode: Check onAccountAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a7e9791015a87a072880062 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX refundAmount: 0 sourceTaxItemId: null taxAmount: 0.1 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-09-30' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage unappliedAmount: 0.1 unappliedAmount: 1 unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' - amount: 2 amountWithoutTax: 2 appliedAmount: 0 appliedToItemId: null comment: '' commitmentId: 4028819f9a4dfdf1019a4e04acfb7e63 commitmentPeriodId: 4028819f9a4dfdf1019a4e06f04a402c createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditFromItemId: 402880e97a56f30b017a574012f00086 creditFromItemSource: CreditMemoItem excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: null deferredRevenueAccountingCodeType: null onAccountAccountingCode: null onAccountAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null id: 402890555a7e9791015a879f06610056 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge quantity: 1 refundAmount: 0 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000001 skuName: New Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7e9791015a7f1756bd0038 sourceItemType: InvoiceDetail subscriptionId: 402890d25bec1155015bec35cc7c0bc7 taxMode: TaxExclusive taxationItems: data: [] unappliedAmount: 2 unitOfMeasure: Each unitPrice: 2 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:07:10' success: true schema: $ref: '#/components/schemas/GETCreditMemoItemsListType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List credit memo items tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/items/{cmitemid}: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific item of a credit memo. A credit memo item is a single line item in a credit memo. operationId: GET_CreditMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems). in: path name: cmitemid required: true schema: type: string - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: amount: 1 amountWithoutTax: 1 appliedAmount: 0 appliedToItemId: null comment: '' commitmentId: 4028819f9a4dfdf1019a4e04acfb7e63 commitmentPeriodId: 4028819f9a4dfdf1019a4e06f04a402c createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditFromItemId: 402880e97a56f30b017a574012f00086 creditFromItemSource: CreditMemoItem excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: Check deferredRevenueAccountingCodeType: null onAccountAccountingCode: null onAccountAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null id: 402890555a7e9791015a879f064d0055 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge quantity: 1 refundAmount: 0 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000001 skuName: New Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7e9791015a7f1756bc0037 sourceItemType: InvoiceDetail subscriptionId: 402890d25bec1155015bec35cc7c0bc7 success: true taxMode: TaxExclusive taxationItems: data: [] unappliedAmount: 1 unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' schema: $ref: '#/components/schemas/GETCreditMemoItemType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a credit memo item tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/parts: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all parts of a credit memo. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a credit memo. Note that a fully refunded credit memo does not contain any credit memo part. operationId: GET_CreditMemoParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: parts: - amount: 3.66 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-02 13:21:55' debitMemoId: null id: 4028905f5a890526015a8d77adea0029 invoiceId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 13:21:55' success: true schema: $ref: '#/components/schemas/GETCreditMemoPartsCollectionType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all parts of a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/parts/{partid}: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific credit memo part. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. A fully refunded credit memo does not contain any credit memo part. operationId: GET_CreditMemoPart parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit memo](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoParts). in: path name: partid required: true schema: type: string - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: amount: 1 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-02 14:00:21' debitMemoId: null id: 4028905f5a890526015a8d9adeb30059 invoiceId: 4028905f5a87c0ff015a87d3f8f10043 success: true updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 14:00:21' schema: $ref: '#/components/schemas/GETCreditMemoPartType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a credit memo part tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/pdfs: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates a PDF file for a specified credit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed credit memo page through the Zuora UI. This REST API operation can be used only if you have the billing document file generation feature and the Billing user permission "Regenerate PDF" enabled. operationId: POST_CreditMemoPDF parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/POSTMemoPdfResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate a credit memo PDF file tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/post: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Posts a credit memo to activate it. You can post credit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). operationId: PUT_PostCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 3.1 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditMemoDate: '2017-03-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 402890555a7e9791015a879f064a0054 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: CM00000012 postedById: 402881e522cf4f9b0122cf5d82860002 postedOn: '2017-03-01 14:28:06' reasonCode: Correcting invoice error referredInvoiceId: 402890555a7e9791015a7f1756aa0035 refundAmount: 0 reversed: false sequenceSetId: null source: API sourceId: null sourceType: Standalone status: Posted success: true targetDate: null taxAmount: 0.1 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 3.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 14:28:06' schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Post a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/refund: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Refunds a full or partial posted credit memo to your customers. Only the amount of unapplied part could be refunded. You can refund a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. When you refund a credit memo, the total number of credit memo items to be refunded must be less than or equal to 15,000. For a use case of this operation, see [Refund processing](https://developer.zuora.com/rest-api/general-concepts/authentication//#Refund-processing). operationId: POST_RefundCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostNonRefRefundType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad0937890e7fca00190e8c290d46fad number: R-00000001 status: Processed type: Electronic methodType: CreditCard accountId: 8ad09be48db5aba7018db604776d4854 amount: 10 refundDate: '2024-07-25' comment: null paymentMethodId: 8ad084db90a5e73b0190c02783f552fa paymentMethodSnapshotId: 8ad0937890e7fca00190e8c290b86fab paymentId: null paymentNumber: null creditMemoId: 8ad0835290c4bb2f0190d9955e414e62 reasonCode: null gatewayId: 2c92c0f972bc6aa90172bc77ccaf379a paymentGatewayNumber: null gatewayResponse: This transaction has been approved by Test gateway. gatewayResponseCode: approve gatewayState: Submitted markedForSubmissionOn: null referenceId: '70028533' secondRefundReferenceId: null softDescriptor: null softDescriptorPhone: null submittedOn: '2024-07-25 00:19:43' settledOn: null cancelledOn: null createdDate: '2024-07-25 00:19:43' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-07-25 00:19:43' updatedById: b243314d594646d3b2651aeedd4be47e refundTransactionTime: '2024-07-25 00:19:43' financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null unappliedPaymentAccountingCode: Accounts Receivable unappliedPaymentAccountingCodeType: AccountsReceivable transferredToAccounting: 'No' gatewayReconciliationStatus: null gatewayReconciliationReason: null payoutId: null success: true schema: $ref: '#/components/schemas/GETRefundCreditMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Refund a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/reverse: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Reverses a posted credit memo. See [Reverse credit memos](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos/C_Management_of_Credit_and_Debit_Memos/Reverse_credit_memos) for more information. You can reverse a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. **Restrictions** You cannot reverse credit memos if any of the following conditions is met: * A credit memo's applied amount is not 0. * A credit memo is not in Posted status. * A credit memo contains more than 2,000 items in total, including credit memo items, discount items, and taxation items. operationId: PUT_ReverseCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutReverseCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: debitMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PutReverseCreditMemoResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Reverse a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/taxation-items: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates taxation items for a credit memo. operationId: POST_CM_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemListForCMType' required: true responses: '200': content: application/json: examples: response: value: taxationItems: - createdById: 8ad084a67f9c7138017fab8a8b511b5a createdDate: '2024-11-15 14:41:04' exemptAmount: 0 id: 8ad0980c932a209d01932e8dcbf83bc8 memoItemId: 8ad086fa932a0b5401932e82ab1f1fb3 invoiceItemId: 8ad086fa932a0b5401932e82a3e5b211 sourceTaxItemId: null jurisdiction: CALIFORNIA locationCode: null name: STATE TAX taxAmount: 0.5 applicableTaxUnRounded: 0.5 country: null taxCode: ServiceTaxCode taxCodeDescription: null taxDate: '2024-11-15' taxRate: 0.05 taxMode: TaxExclusive taxRateDescription: null taxRateType: Percentage updatedById: 8ad084a67f9c7138017fab8a8b511b5a updatedDate: '2024-11-15 14:41:04' financeInformation: salesTaxPayableAccountingCode: Sales Tax Payable salesTaxPayableAccountingCodeType: SalesTaxPayable accountsReceivableAccountingCode: Accounts Receivable accountsReceivableAccountingCodeType: AccountsReceivable success: true schema: $ref: '#/components/schemas/GETTaxationItemListType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create taxation items for a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/unapply: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Unapplies an applied credit memo from one or more invoices and debit memos. The full applied amount from invoices and debit memos is transferred into the unapplied amount of the credit memo. You can unapply a credit memo from an invoice or a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. When you unapply a credit memo, the total number of credit memo items and the items that credit memo items to be unapplied from must be less than or equal to 15,000. If the limit is hit, you can follow the following instructions: - If you want to unapply one credit memo without specifying invoices or debit memos and the limit is hit, you have to specify the invoice items or debit memo items in the request to decrease the number of items. - If you want to unapply one credit memo from multiple specified invoices or debit memos, decrease the number of invoices or debit memos in the request. - If you want to unapply one credit memo from a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000. - If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000. - When unapplying a credit memo, the total number of the credit memo's item parts must be less than or equal to 1,000. Otherwise, the operation would fail and an error message would pop up. When you see this error, you can try using the Unapply a credit memo API as an alternative. Similarly, make sure that all the requirements listed in the API reference are met. operationId: PUT_UnapplyCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnapplyCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: id: 8a90aac892dc8c3a0192dce41af10077 number: CM00000619 accountId: 8a90b4488e7d5c0f018e7db3892400b2 accountNumber: A00000370 currency: USD creditMemoDate: '2024-10-30' targetDate: null postedById: 2c92c8f95e2d6ebb015e325df48e02da postedOn: '2024-10-30 18:06:30' status: Posted amount: 15 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 1 refundAmount: 0 appliedAmount: 14 comment: '' source: AdhocFromInvoice sourceId: null referredInvoiceId: 8a90d7a892d82d920192dbcb314501c7 reasonCode: Correcting invoice error createdDate: '2024-10-30 18:06:29' createdById: 2c92c8f95e2d6ebb015e325df48e02da updatedDate: '2024-10-30 18:08:37' updatedById: 2c92c8f95e2d6ebb015e325df48e02da cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Invoice eInvoiceStatus: Failed eInvoiceErrorCode: IntegrationError eInvoiceErrorMessage: Input string was null. eInvoiceFileId: null taxMessage: null billToContactId: null billToContactSnapshotId: 8a90b4488e7d5c0f018e7dbef1f900c9 sequenceSetId: null invoiceGroupNumber: null revenueImpacting: 'Yes' success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unapply a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/unpost: put: description: |- **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Unposts a credit memo that is in Posted status. If a credit memo has been applied or refunded, you are not allowed to unpost it. After a credit memo is unposted, its status becomes Draft. You can unpost credit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). You can prevent an unpost operation by configuring the 'Do not allow unposting invoices and memos if their revenue is already recognized in a closed accounting period' accounting rule. The default value of this rule is set to 'disabled.' For more information, see [Configure Accounting Rules](https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance/D_Finance_Settings/D_Configure_Accounting_Rules#Do_not_allow_unposting_invoices_and_memos_if_their_revenue_is_already_recognized_in_a_closed_accounting_period). operationId: PUT_UnpostCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 3.1 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditMemoDate: '2017-03-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 402890555a7e9791015a879f064a0054 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: CM00000012 postedById: 402881e522cf4f9b0122cf5d82860002 postedOn: '2017-03-01 14:28:06' reasonCode: Correcting invoice error referredInvoiceId: 402890555a7e9791015a7f1756aa0035 refundAmount: 0 reversed: false sequenceSetId: null source: API sourceId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0.1 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 3.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 14:28:06' schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unpost a credit memo tags: - Credit Memos /v1/credit-memos/invoice/{invoiceKey}: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates an ad-hoc credit memo from an invoice. You can create a credit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. For a use case of this operation, see [Create credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Create-credit-memo). Zero-amount memo items are supported in the following scenarios: - If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero. - If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice. operationId: POST_CreditMemoFromInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: | The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001. in: path name: invoiceKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditMemoFromInvoiceRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8a90e4a792d82d8c0192dbda90671d66 number: CM00000618 accountId: 8a90b4488e7d5c0f018e7db3892400b2 accountNumber: A00000370 currency: USD creditMemoDate: '2024-10-30' targetDate: null postedById: null postedOn: null status: Draft amount: 10 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 10 refundAmount: 0 appliedAmount: 0 comment: null source: AdhocFromInvoice sourceId: null referredInvoiceId: 8a90d7a892d82d920192dbcb314501c7 reasonCode: Correcting invoice error createdDate: '2024-10-30 13:16:27' createdById: 2c92c8f95e2d6ebb015e325df48e02da updatedDate: '2024-10-30 13:16:27' updatedById: 2c92c8f95e2d6ebb015e325df48e02da cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Invoice eInvoiceStatus: null eInvoiceErrorCode: null eInvoiceErrorMessage: null eInvoiceFileId: null taxMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null invoiceGroupNumber: null revenueImpacting: 'Yes' success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a credit memo from an invoice tags: - Credit Memos /v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}: get: description: |- **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about a specific Async Credit Memo Unapply job. operationId: getUnapplyCreditMemoAsyncJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique ID of a Credit Memo Async Unapply Job Id. For example, 8a92ade496140e830196148cd0af000a. in: path name: unapplyAsyncJobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' responses: '200': content: application/json: example: id: 8a92ade496140e830196148cd0af000a status: Processed operationType: AsyncCreditMemoUnapply referenceId: 4028905f5a890526015a8d73f73d0015 referenceType: CreditMemo error: null success: true schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an async unapply credit memo job by ID tags: - Credit Memos /v1/credit-memos/apply-async-jobs/{applyAsyncJobId}: get: description: |- **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about a specific Async Credit Memo Apply job. operationId: getApplyCreditMemoAsyncJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique ID of a Credit Memo Async Apply Job Id. For example, 8a92ade496140e830196141f6cfa0001. in: path name: applyAsyncJobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' responses: '200': content: application/json: example: id: 8a92ade496140e830196141f6cfa0001 status: Processed operationType: AsyncCreditMemoApply referenceId: 4028905f5a890526015a8d73f73d0015 referenceType: CreditMemo error: null success: true schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an async unapply credit memo job by ID tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/apply-async: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Asynchronously applies a posted credit memo to one or more invoices You can apply a credit memo to an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. When you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 300,000. The maximum number of invoices that you can specify in the request is 1,000 If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000: (number of invoice items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule. operationId: applyCreditMemoAsync parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/AsyncApplyCreditMemoRequest' required: true responses: '200': content: application/json: example: id: 402881e522cf4f9b0122cf5d82860002 status: Pending operationType: AsyncCreditMemoApply referenceId: 4028905f5a890526015a8d73f73d0015 referenceType: CreditMemo error: null success: true schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Apply a credit memo aysnchronously tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/unapply-async: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Asynchronously Unapplies an applied credit memo from one or more invoices. The full applied amount from invoices is transferred into the unapplied amount of the credit memo. You can unapply a credit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) When you unapply a credit memo, the total number of credit memo items and the items that credit memo items to be unapplied from must be less than or equal to 300,000. The maximum number of invoices that you can specify in the request is 1,000 operationId: unapplyCreditMemoAsync parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/AsyncUnapplyCreditMemoRequest' required: true responses: '200': content: application/json: example: id: 8a92ade496140e830196148cd0af000a status: Pending operationType: AsyncCreditMemoUnapply referenceId: 8a8082e65b27f6c3015ba45ff82c7172 referenceType: CreditMemo error: null success: true schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unapply a credit memo asynchronously tags: - Credit Memos /v1/debit-memos: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all debit memos associated with all customer accounts. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. Examples: - /v1/debit-memos?status=Posted - /v1/debit-memos?referredInvoiceId=null&status=Draft - /v1/debit-memos?status=Posted&type=External&sort=+number operationId: GET_DebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | This parameter filters the response based on the `accountId` field. in: query name: accountId required: false schema: type: string - description: | This parameter filters the response based on the `accountNumber` field. in: query name: accountNumber required: false schema: type: string - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `balance` field. in: query name: balance required: false schema: format: double type: number - description: | This parameter filters the response based on the `beAppliedAmount` field. in: query name: beAppliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `currency` field. in: query name: currency required: false schema: type: string - description: | This parameter filters the response based on the `debitMemoDate` field. in: query name: debitMemoDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `dueDate` field. in: query name: dueDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `number` field. in: query name: number required: false schema: type: string - description: | This parameter filters the response based on the `referredInvoiceId` field. in: query name: referredInvoiceId required: false schema: type: string - description: | This parameter filters the response based on the `status` field. in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string - description: | This parameter filters the response based on the `targetDate` field. in: query name: targetDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `taxAmount` field. in: query name: taxAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `totalTaxExemptAmount` field. in: query name: totalTaxExemptAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - description: | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by debit memo number. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - number - accountId - debitMemoDate - targetDate - dueDate - amount - taxAmount - totalTaxExemptAmount - balance - beAppliedAmount - referredInvoiceId - createdDate - createdById - updatedDate - updatedById Examples: - /v1/debit-memos?sort=+number - /v1/debit-memos?status=Processed&sort=-number,+amount in: query name: sort required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: debitmemos: - accountId: 402890555a7e9791015a7f15fe44001c accountNumber: AN_1679649466484 amount: 50 autoPay: true balance: 50 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: the comment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:24:14' currency: USD debitMemoDate: '2017-10-17' dueDate: '2017-11-16' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 402890555a87d7f5015a892f2ba10057 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a87d7f5015a892f2c5c0060 number: DM00000006 paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:24:14' - accountId: 402890555a7d4022015a7dabf5f60088 accountNumber: AN_1679649466488 amount: 0.01 autoPay: true balance: 0.01 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: the comment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:13:15' currency: USD debitMemoDate: '2017-11-30' dueDate: '2017-12-30' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 402890555a87d7f5015a89251edc0045 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000003 paymentTerm: null postedById: null postedOn: null reasonCode: Charge Dispute referredInvoiceId: 402890555a7d4022015a7dadb3b300a4 sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0.01 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:13:15' - accountId: 402890555a7d4022015a7dabf5f60088 accountNumber: AN_1679649466488 amount: 9 autoPay: true balance: 9 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:01:00' currency: USD debitMemoDate: '2017-03-01' dueDate: '2017-03-31' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 402890555a87d7f5015a8919e4fe002e invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a87d7f5015a8919e95d003a number: DM00000002 paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: 402890555a7d4022015a7dadb3b300a4 sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 8 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:01:00' - accountId: 402890555a7e9791015a7f15fe44001c accountNumber: AN_1679649466684 amount: 8.02 autoPay: true balance: 8.02 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:26:16' currency: USD debitMemoDate: '2017-03-01' dueDate: '2017-03-31' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 402890555a7e9791015a87b082940067 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a7e9791015a87b083f00072 number: DM00000001 paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: 402890555a7e9791015a7f1756aa0035 sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0.02 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:45:03' success: true schema: $ref: '#/components/schemas/GETDebitMemoCollectionType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List debit memos tags: - Debit Memos post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates an ad-hoc debit memo from a product rate plan charge. Zuora supports the creation of debit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models. When debit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency. You can create a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: POST_DebitMemoFromPrpc parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoFromChargeRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8ad093789169a0c001916e6be7cf7113 number: DM00000002 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 debitMemoDate: '2024-08-19' currency: USD targetDate: null dueDate: '2024-09-18' postedOn: null postedById: null status: Draft amount: 10 taxAmount: 0 totalTaxExemptAmount: 0 balance: 10 beAppliedAmount: 0 autoPay: true comment: null referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2024-08-19 23:14:11' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-08-19 23:14:11' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null referredCreditMemoId: 1a2b3c4d5e6f latestPDFFileId: ac1ebc24569sd taxStatus: Complete sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a debit memo from a charge tags: - Debit Memos put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Updates the due date for multiple debit memos in one single request. This API operation will be deprecated. You can use the [Update debit memos](https://developer.zuora.com/api-references/api/operation/PUT_BulkUpdateDebitMemos) instead, which provides more flexible functionality. operationId: PUT_UpdateDebitMemosDueDates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBatchDebitMemosRequest' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update due dates for debit memos tags: - Debit Memos /v1/debit-memos/bulk: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates multiple debit memos from invoices or product rate plan charges. You can create a maximum of 50 debit memos in one single request. - If you set the `sourceType` request field to `Invoice`, you can create multiple debit memos from invoices. - If you set the `sourceType` request field to `Standalone`, you can create multiple debit memos from product rate plan charges. The debit memos that are created are each in separate database transactions. If the creation of one debit memo fails, other debit memos can still be created successfully. You can create debit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: POST_CreateDebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkDebitMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: 4028ab1f87121698018712fef63e33cb accountNumber: AN_Test11679650911374 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: 3e2bcd869cea43eeb00d7a20cc1cb72b createdDate: '2023-03-24 15:12:01' currency: USD debitMemoDate: '2023-03-24' dueDate: '2023-03-24' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018712ff1b0633e2 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 3e2bcd869cea43eeb00d7a20cc1cb72b updatedDate: '2023-03-24 15:12:01' - objectIndex: 1 processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id test. success: false success: true schema: $ref: '#/components/schemas/BulkDebitMemosResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create debit memos tags: - Debit Memos put: description: | **Notes:** - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. - You can update debit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. Updates the basic and finance information about multiple debit memos. You can update a maximum of 50 credit memos in one single request. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The [Edit credit and debit memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API) tutorial demonstrates how to use this operation to add and delete memo items. The credit memos that are updated are each in separate database transactions. If the update of one debit memo fails, other debit memos can still be updated successfully. operationId: PUT_UpdateDebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBulkDebitMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: 4028ab1f87121698018726851cc765ee accountNumber: AN_Test11679978470016 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: new comment123 createdById: aff81dbb5dd846868685592640363b5b createdDate: '2023-03-28 10:11:45' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f8712169801872685a5f46605 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: aff81dbb5dd846868685592640363b5b updatedDate: '2023-03-28 10:12:37' - id: 2c98907562482a8301624b9c0a1a0056 objectIndex: 1 processId: string reasons: - code: string message: string success: false success: true schema: $ref: '#/components/schemas/BulkDebitMemosResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update debit memos tags: - Debit Memos /v1/debit-memos/pdf-status: get: description: | Retrieves the PDF generation statuses of a batch of debit memos. operationId: Get_DebitMemoPdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: 'The IDs or numbers of the debit memos separated by commas. For example - `?debitMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,DM0000001`. A maximum of 50 keys can be entered in this field. ' in: query name: debitMemoKeys required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: example: debitMemoFiles: - debitMemoId: 402824aa8cc894d5018cc8a120576881 debitMemoNumber: DM00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:32:19' updatedOn: '2024-01-01 11:32:19' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - debitMemoId: 2c98908a904dfc2601904e6e14090241 debitMemoNumber: DM00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - debitMemoId: 623935cc6ee105f7341ee1d453809214 debitMemoNumber: DM00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true schema: $ref: '#/components/schemas/GetDebitMemoPdfStatusBatchResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: example: processId: processId reasons: - code: '50000020' message: Credit memo key is required success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Forbidden headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve the PDF file generation status of debit memos tags: - Debit Memos x-accepts: application/json /v1/debit-memos/{debitMemoId}/application-parts: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about the payments or credit memos that are applied to a specified debit memo. If you use the Zuora version 341.0 or a [later available version](https://developer.zuora.com/v1-api-reference/api-versions/), this operation will return only processed payments applied to the debit memos. For Zuora versions earlier than 341.0, it returns all payments associated with the debit memo regardless of the payment status. operationId: GET_DebitMemoApplicationParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. in: path name: debitMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: applicationParts: - appliedAmount: 22 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:42:16' creditMemoId: 4028905f60a165a50160b4f632ff023d paymentId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:42:16' - appliedAmount: 11 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:41:38' creditMemoId: null paymentId: 4028905f60a165a50160b4f5d5cb0229 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:41:38' success: true schema: $ref: '#/components/schemas/GetDebitMemoApplicationPartCollectionType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all application parts of a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoId}/items/{dmitemid}/taxation-items: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about the taxation items of a specific debit memo item. operationId: GET_TaxationItemsOfDebitMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems). in: path name: dmitemid required: true schema: type: string - description: | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. in: path name: debitMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: data: - balance: 10 creditAmount: 0 exemptAmount: 10 financeInformation: salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402883836904567d01690530df760231 jurisdiction: Jurisdiction locationCode: '8' name: taxName_0 paymentAmount: 0 sourceTaxItemId: null taxAmount: 10 taxCode: taxCode taxCodeDescription: taxCodeDescription taxDate: '2016-10-10' taxRate: 0.1 taxRateDescription: taxRateDescription taxRateType: Percentage success: true schema: $ref: '#/components/schemas/GETTaxationItemsOfDebitMemoItemType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all taxation items of a debit memo item tags: - Debit Memos /v1/debit-memos/{debitMemoKey}: delete: description: |- **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Deletes a debit memo. Only debit memos with the Cancelled status can be deleted. You can delete a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. The Edit credit and debit memos tutorial demonstrates how to use this operation to add and delete memo items. operationId: DELETE_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a debit memo tags: - Debit Memos get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific debit memo. operationId: GET_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722ff25be58a1 accountNumber: AN_Test11679919358984 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: 0124a1a5d0f84d4288d875fc3b34b1e1 createdDate: '2023-03-27 17:46:01' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018722ff2bff58b8 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 0124a1a5d0f84d4288d875fc3b34b1e1 updatedDate: '2023-03-27 17:46:01' schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a debit memo tags: - Debit Memos put: description: | **Notes:** - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. - You can update a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. Updates the basic and finance information about a debit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The [Edit credit and debit memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API) tutorial demonstrates how to use this operation to add and delete memo items. operationId: PUT_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTDebitMemoType' required: true responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722f82d133fe4 accountNumber: AN_Test11679918902100 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: Details about this Debit Memo createdById: 97e12d40f0ab4418a95a93118b272fb6 createdDate: '2023-03-27 17:38:24' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018722f8335b3ffb invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 97e12d40f0ab4418a95a93118b272fb6 updatedDate: '2023-03-27 17:38:27' schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/cancel: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Cancels a debit memo. Only debit memos with the Draft status can be cancelled. You can cancel a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: PUT_CancelDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722fd2e705066 accountNumber: AN_Test11679919230033 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: bc0211e8ca1440eb97a0aff808f87293 cancelledOn: '2023-03-27 17:43:59' comment: This is a comment createdById: bc0211e8ca1440eb97a0aff808f87293 createdDate: '2023-03-27 17:43:52' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018722fd34c6507d invoiceGroupNumber: N-0001 latestPDFFileId: 4028ab1f87121698018722fd39fe5087 number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Canceled success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: bc0211e8ca1440eb97a0aff808f87293 updatedDate: '2023-03-27 17:43:59' schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/collect: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. This API operation provides an easy way to let the client-side to collect an existing posted debit memo. It supports the following steps: 1. Apply unapplied credit memos to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied credit memos. 2. Apply unapplied payments to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied payments. 3. Process payment to the posted debit memo if there is an open-balance on it. **Restrictions** Since this API will do lots of works, and some of them are resource consuming, we need to restrict the usage of this API by the following conditions: 1. If the target debit memo gets more than 10 debit memo items, the request will be rejected. 2. If `CreditMemo` is specified in `applicationOrder`, when there are more than 25 credit memos will be used to apply to the debit memo, the request will be rejected. 3. If `CreditMemo` is specified in `applicationOrder`, when there are more than 100 credit memo items will be used to apply to the debit memo, the request will be rejected. 4. If `UnappliedPayment` is specified in `applicationOrder`, when there are more than 25 payments will be used to apply to the debit memo, the request will be rejected. operationId: POST_DebitMemoCollect parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoCollectRequest' required: true responses: '200': content: application/json: examples: response: value: debitMemo: id: 8ad0912492f64b9001931936cac36351 number: DM00000001 appliedCreditMemos: [] appliedPayments: [] processedPayment: id: 8ad0869992f632860193249dfe1a0ead number: P-00001541 status: Processed amount: 10 paymentMethodId: 8ad09bce83f1da020183f97e24821c4b gatewayId: 8ad095dd813e750f0181461a8e350ce7 gatewayResponse: This transaction has been approved by the gateway. gatewayResponseCode: approve success: true schema: $ref: '#/components/schemas/DebitMemoCollectResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Collect a posted debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/emails: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Sends a posted debit memo to the specified email addresses manually. ### Notes - You must activate the **Email Debit Memo | Manually email Debit Memo** notification before emailing debit memos. To include the debit memo PDF in the email, select the **Include Debit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information. - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Debit Memo Default Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. - The debit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met: * The `useEmailTemplateSetting` field is set to `false`. * The email addresses are not specified in the `emailAddresses` field. operationId: POST_EmailDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostDebitMemoEmailType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Email a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/files: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Uploads an externally generated PDF file for a debit memo that is in Draft or Posted status. To use this operation, you must enable the Modify Debit Memo permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one debit memo. operationId: POST_UploadFileForDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: description: | The PDF file to upload for the debit memo. format: binary type: string type: object responses: '200': content: application/json: examples: response: value: fileId: 40289f466463d683016463ef8b7301a3 success: true schema: $ref: '#/components/schemas/POSTUploadFileResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a file for a debit memo tags: - Debit Memos x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@DebitMemoFile.pdf" "https://rest.zuora.com/v1/debit-memos/402890555a87d7f5015a8919e4fe002e/files" get: description: | Retrieves the information about all PDF files of a specified debit memo. Debit Memo PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response. operationId: GET_DebitMemoFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: debitMemoFiles: - id: 8a90a24f8e128020018e12ebcd010470 pdfFileUrl: /v1/files/8a90a24f8e128020018e12ebccfa046f versionNumber: 1709714426109 - id: 8a90b5148c6d127b018c6d1e46160230 pdfFileUrl: /v1/files/8a90b5148c6d127b018c6d1e4610022f versionNumber: 1702637741618 success: true schema: $ref: '#/components/schemas/GETDebitMemoFilesResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all files of a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/items: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all items of a debit memo. A debit memo item is a single line item in a debit memo. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. Examples: - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100 - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate operationId: GET_DebitMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `beAppliedAmount` field. in: query name: beAppliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `id` field. in: query name: id required: false schema: type: string - description: | This parameter filters the response based on the `serviceEndDate` field. in: query name: serviceEndDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `serviceStartDate` field. in: query name: serviceStartDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `sku` field. in: query name: sku required: false schema: type: string - description: | This parameter filters the response based on the `skuName` field. in: query name: skuName required: false schema: type: string - description: | This parameter filters the response based on the `sourceItemId` field. in: query name: sourceItemId required: false schema: type: string - description: | This parameter filters the response based on the `subscriptionId` field. in: query name: subscriptionId required: false schema: type: string - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - description: | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by updated date. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - id - amount - beAppliedAmount - sku - skuName - serviceStartDate - serviceEndDate - sourceItemId - createdDate - createdById - updatedDate - updatedById - subscriptionId Examples: - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate in: query name: sort required: false schema: type: string responses: '200': content: application/json: examples: response: value: items: - amount: 1 amountWithoutTax: 1 appliedToItemId: 402890555a7d4022015a2dadb3b700a6 balance: 1 beAppliedAmount: 0 comment: This is comment! createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:13:15' excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: Subscription Revenue deferredRevenueAccountingCodeType: SalesRevenue recognizedRevenueAccountingCode: Subscription Revenue recognizedRevenueAccountingCodeType: SalesRevenue id: 402890555a87d7f5015a89251ede0046 processingType: Charge quantity: 1 serviceEndDate: '2017-11-30' serviceStartDate: '2017-11-01' sku: SKU-00000002 skuName: SKU-30 soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7d4022015a7dadb3b700a6 sourceItemType: InvoiceDetail subscriptionId: null taxMode: TaxExclusive taxationItems: data: - balance: 0.01 creditAmount: 0 exemptAmount: 0 financeInformation: salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a87d7f5015a89251ef10047 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX paymentAmount: 0 sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1 taxAmount: 0.01 taxCode: ZtaxCode taxCodeDescription: '' taxDate: '2017-11-30' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:13:15' success: true schema: $ref: '#/components/schemas/GETDebitMemoItemCollectionType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List debit memo items tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/items/{dmitemid}: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about a specific item of a debit memo. A debit memo item is a single line item in a debit memo. operationId: GET_DebitMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems). in: path name: dmitemid required: true schema: type: string - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: amount: 1 amountWithoutTax: 1 appliedToItemId: 402890555a7d4022015a2dadb3b700a6 balance: 1 beAppliedAmount: 0 comment: aa createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:01:00' excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: Subscription Revenue deferredRevenueAccountingCodeType: SalesRevenue recognizedRevenueAccountingCode: Subscription Revenue recognizedRevenueAccountingCodeType: SalesRevenue id: 402890555a87d7f5015a8919e500002f processingType: Charge quantity: 1 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000002 skuName: ZTax Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7d4022015a7dadb3b700a6 sourceItemType: InvoiceDetail subscriptionId: null success: true taxMode: TaxExclusive taxationItems: data: - balance: 5 creditAmount: 0 exemptAmount: 0 financeInformation: salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a87d7f5015a8919e8450031 jurisdiction: USA locationCode: '' name: my tax paymentAmount: 0 sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1 taxAmount: 5 taxCode: ZtaxCode taxCodeDescription: '' taxDate: '2017-02-27' taxRate: 5 taxRateDescription: desc3 taxRateType: FlatFee unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:01:00' schema: $ref: '#/components/schemas/GETDebitMemoItemType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a debit memo item tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/pdfs: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates a PDF file for a specified debit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed debit memo page through the Zuora UI. This REST API operation can be used only if you have the billing document file generation feature and the Billing user permission "Regenerate PDF" enabled. operationId: POST_DebitMemoPDF parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/POSTMemoPdfResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate a debit memo PDF file tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/post: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Posts a debit memo to activate it. You can post debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). operationId: PUT_PostDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722fa86dc4823 accountNumber: AN_Test11679919056161 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: e758a64e80f54439913241f9aa537127 createdDate: '2023-03-27 17:40:58' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018722fa8d73483a invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: e758a64e80f54439913241f9aa537127 postedOn: '2023-03-27 17:41:03' reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Posted success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: e758a64e80f54439913241f9aa537127 updatedDate: '2023-03-27 17:41:03' schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Post a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/taxation-items: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates taxation items for a debit memo. operationId: POST_DM_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemListForDMType' required: true responses: '200': content: application/json: examples: response: value: taxationItems: - createdById: 8ad084a67f9c7138017fab8a8b511b5a createdDate: '2024-11-18 11:32:56' exemptAmount: 0 id: 8ad0980c93300db701933d549f355262 memoItemId: 8ad093f793300daf01933d50a548781f invoiceItemId: null sourceTaxItemId: null jurisdiction: CALIFORNIA locationCode: null name: STATE TAX taxAmount: 0.5 applicableTaxUnRounded: 0.5 country: null taxCode: ServiceTaxCode taxCodeDescription: null taxDate: '2024-11-18' taxRate: 0.05 taxMode: TaxExclusive taxRateDescription: null taxRateType: Percentage updatedById: 8ad084a67f9c7138017fab8a8b511b5a updatedDate: '2024-11-18 11:32:56' financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null salesTaxPayableAccountingCode: Sales Tax Payable salesTaxPayableAccountingCodeType: SalesTaxPayable accountsReceivableAccountingCode: Accounts Receivable accountsReceivableAccountingCodeType: AccountsReceivable success: true schema: $ref: '#/components/schemas/GETTaxationItemListType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create taxation items for a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/unpost: put: description: |- **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Unposts a debit memo that is in Posted status. If any credit memo or payment has been applied to a debit memo, you are not allowed to unpost the debit memo. After a debit memo is unposted, its status becomes Draft. You can unpost debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). You can prevent an unpost operation by configuring the 'Do not allow unposting invoices and memos if their revenue is already recognized in a closed accounting period' accounting rule. The default value of this rule is set to 'disabled.' For more information, see [Configure Accounting Rules](https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance/D_Finance_Settings/D_Configure_Accounting_Rules#Do_not_allow_unposting_invoices_and_memos_if_their_revenue_is_already_recognized_in_a_closed_accounting_period). operationId: PUT_UnpostDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722f3af193744 accountNumber: AN_Test11679918607694 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: c24f12918d5b45d0b7f9da297b8b7a9d createdDate: '2023-03-27 17:33:29' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018722f3b60c375b invoiceGroupNumber: N-0001 latestPDFFileId: 4028ab1f87121698018722f3bb0b376b number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: c24f12918d5b45d0b7f9da297b8b7a9d updatedDate: '2023-03-27 17:33:42' schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unpost a debit memo tags: - Debit Memos /v1/debit-memos/invoice/{invoiceKey}: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates an ad-hoc debit memo from an invoice. You can create a debit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: POST_DebitMemoFromInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of an invoice that you want to create a debit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoFromInvoiceRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8a90a19d9310bb3c0193197cb4700501 number: DM00000045 accountId: 8a90b4488e7d5c0f018e7db3892400b2 accountNumber: A00000370 debitMemoDate: '2024-11-11' currency: USD targetDate: null dueDate: '2024-12-11' postedOn: null postedById: null status: Draft amount: 10 taxAmount: 0 totalTaxExemptAmount: 0 balance: 10 beAppliedAmount: 0 autoPay: true comment: null referredInvoiceId: 8a90cc5c9301541f01930186636b1400 transferredToAccounting: false reasonCode: Correcting invoice error createdDate: '2024-11-11 12:30:23' createdById: 2c92c8f95e2d6ebb015e325df48e02da updatedDate: '2024-11-11 12:30:23' updatedById: 2c92c8f95e2d6ebb015e325df48e02da cancelledOn: null cancelledById: null referredCreditMemoId: null latestPDFFileId: null taxStatus: null sourceType: Invoice taxMessage: null billToContactId: 8a90b4488e7d5c0f018e7db3896100b4 billToContactSnapshotId: null soldToContactId: null soldToContactSnapshotId: null paymentTerm: Net 30 eInvoiceStatus: null eInvoiceErrorCode: null eInvoiceErrorMessage: null eInvoiceFileId: null sequenceSetId: acd16fac492111e9a0d70cc47a32b062 invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a debit memo from an invoice tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/write-off: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Writes off a debit memo. By writing off a debit memo, a credit memo is automatically created and applied to the debit memo. The generated credit memo items and credit memo taxation items are applied to the corresponding debit memo items and debit memo taxation items respectively. **Note**: * This API operation is available only if you have enabled the enhanced write-off permission for your tenant. Contact Zuora Global Support to enable this permission. * The total amount must be equal to the amount entered at the invoice item level. * If the non revenue impact value is set to Yes, then the non revenue write off accounting code must be specified. operationId: PUT_WriteOffDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTWriteOffDebitMemoRequest' required: true responses: '200': content: application/json: examples: response: value: creditMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PUTWriteOffDebitMemoResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Write off a debit memo tags: - Debit Memos /v1/einvoice/service-providers: get: description: | Lists information about e-invoicing service providers. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingServiceProviders parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: serviceProviders: - id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'false' companyIdentifier: CompanySample1 schema: $ref: '#/components/schemas/ListEInvoicingServiceProvidersResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List e-invoicing service providers tags: - E-Invoicing post: description: | Creates an e-invoicing service provider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: POST_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEInvoicingServiceProviderRequest' required: true responses: '200': content: application/json: examples: response: value: id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'false' companyIdentifier: CompanySample1 apiKey: SampleApiKey use_certificate: false clientCertificate: U3dhZ2dlciByb2Nrcw== clientCertificateType: PKCS12 schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an e-invoicing service provider tags: - E-Invoicing /v1/einvoice/service-providers/{key}: delete: description: | Deletes an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: DELETE_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoicing service provider that you want to in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an e-invoicing service provider tags: - E-Invoicing get: description: | Retrieves information about an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoicing service provider that you want to retrieve information about. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'false' companyIdentifier: CompanySample1 schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an e-invoicing service provider tags: - E-Invoicing put: description: | Updates information about an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_UpdateEInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoicing service provider that you want to update. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoicingServiceProviderRequest' required: true responses: '200': content: application/json: examples: response: value: id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'true' companyIdentifier: CompanySample1 apiKey: SampleApiKey use_certificate: false clientCertificate: U3dhZ2dlciByb2Nrcw== clientCertificateType: PKCS12 schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an e-invoicing service provider tags: - E-Invoicing /v1/einvoice/business-regions: get: description: | Lists information about e-invoicing business regions. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingBusinessRegions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: regions: - id: 8ad083528ee62fe1018eea6c5dd11e01 country: AU businessName: Avalara Inc. businessNumber: '74004085818' businessNumberSchemeId: '0151' tradeName: Test trade endpointId: '74004085818' endpointSchemeId: '0151' taxRegisterNumber: '1577240348' state: '' city: '' postalCode: '' addressLine1: '' addressLine2: '' contactName: '' phoneNumber: '' email: '' serviceProviderId: 8ad093788ea359ca018ea75fb12a6348 businessRegionNumber: EIBR-00000010 digitalSignatureEnable: 'false' digitalSignatureBoxEnable: 'false' digitalSignatureBoxPosX: '0' digitalSignatureBoxPosY: '0' responseMapping: '{}' processType: PEPPOLNetwork invoiceEnabled: 'true' creditMemoEnabled: 'true' debitMemoEnabled: 'true' invoiceFilters: 'null' creditMemoFilters: 'null' debitMemoFilters: 'null' fileFormat: B2B: - XML B2C: - '' B2G: - XML - id: 8ad081dd8f7c5447018f7fdff3a75823 country: BR businessName: Seller business name businessNumber: '02593165000140' businessNumberSchemeId: '' tradeName: Seller trade name endpointId: Seller end point id 08992 endpointSchemeId: '099' taxRegisterNumber: TAX393982838 state: '' city: '' postalCode: '1' addressLine1: '' addressLine2: '' contactName: '' phoneNumber: '' email: '' serviceProviderId: 8ad097b4905a5adf01907433df216e37 businessRegionNumber: EIBR-00000012 digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 responseMapping: {} processType: ClearanceWithCancellation invoiceEnabled: true creditMemoEnabled: false debitMemoEnabled: false invoiceFilters: null creditMemoFilters: null debitMemoFilters: null fileFormat: null success: true schema: $ref: '#/components/schemas/ListEInvoicingBusinessRegionsResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List e-invoicing business regions tags: - E-Invoicing post: description: | Creates an e-invoicing business region. You must create business regions to store the business detail information as a seller. If you have multiple GSTINs for different states, you can create multiple business region objects for India. The business region objects can be looked up according to the country and state, and its related fields can be mapped accordingly within the e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: POST_CreateEInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEInvoicingBusinessRegionRequest' required: true responses: '200': content: application/json: examples: response: value: addressLine1: '' addressLine2: '' businessName: legal business name businessNumber: '20002039' businessNumberSchemaId: '88' businessRegionNumber: EIBR-00000002 city: Tokyo contactName: '' country: JP digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: '' id: 4028b2aa8890c524018890c7e9ef3826 invoiceFilters: - objectType: Invoice condition: field: SoldToContact.Country operator: eq value: India phoneNumber: '' postalCode: '368779' responseMapping: {} serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: '' taxRegisterNumber: TAX393999 tradeName: Zuora fileFormat: B2B: - XML B2C: - '' B2G: - XML schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an e-invoicing business region tags: - E-Invoicing /v1/einvoice/business-regions/{key}: delete: description: | Deletes an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: DELETE_EInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unqiue ID or number of the e-invoicing business region that you want to delete. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an e-invoicing business region tags: - E-Invoicing get: description: | Retrieves information about an e-invoicing business region. You can search for an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unqiue ID or number of the e-invoicing business region that you want to retrieve information about. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: - id: 8ad083528ee62fe1018eea6c5dd11e01 country: AU businessName: Avalara Inc. businessNumber: '74004085818' businessNumberSchemeId: '0151' tradeName: Test trade endpointId: '74004085818' endpointSchemeId: '0151' taxRegisterNumber: '1577240348' state: '' city: '' postalCode: '' addressLine1: '' addressLine2: '' contactName: '' phoneNumber: '' email: '' serviceProviderId: 8ad093788ea359ca018ea75fb12a6348 businessRegionNumber: EIBR-00000010 digitalSignatureEnable: 'false' digitalSignatureBoxEnable: 'false' digitalSignatureBoxPosX: '0' digitalSignatureBoxPosY: '0' responseMapping: '{}' processType: PEPPOLNetwork invoiceEnabled: 'true' creditMemoEnabled: 'true' debitMemoEnabled: 'true' invoiceFilters: 'null' creditMemoFilters: 'null' debitMemoFilters: 'null' fileFormat: B2B: - XML B2C: - '' B2G: - XML schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an e-invoicing business region tags: - E-Invoicing put: description: | Updates an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_UpdateEInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unqiue ID or number of the e-invoicing business region that you want to update. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoicingBusinessRegionRequest' required: true responses: '200': content: application/json: examples: response: value: addressLine1: null addressLine2: null businessName: legal business name businessNumber: '20002039' businessNumberSchemaId: '88' businessRegionNumber: EIBR-00000002 city: Tokyo contactName: null country: JP digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: null endpointId: '8992' endpointSchemeId: '88' phoneNumber: null postalCode: '368779' responseMapping: {} serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: null taxRegisterNumber: TAX393999 tradeName: Zuora fileFormat: B2B: - XML B2C: - '' B2G: - XML schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an e-invoicing business region tags: - E-Invoicing /v1/e-invoice/mandates: get: description: | Fetches mandates for downloading files based on the country code, category, and process type selection. This API operation returns the the list of file formats in which the document can be downloaded. **Note**: This operation is available only if you have the E-Invoicing feature for Avalara in **Early Availabiltiy** phase enabled. operationId: getEinvoiceMandates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | 2-digit country code. in: query name: countryCode schema: type: string example: AU - description: | The process type of the e-invoicing business region. - If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`. - If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`. - If the service provider is PEPPOL, the process type is `Unknown`. in: query name: processType schema: type: string example: PEPPOLNetwork enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown - description: The service provider that is associated with the country and process type. in: query name: provider schema: type: string example: 8ad093788ea359ca018ea75fb12a6348 - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: Success: value: data: - countryCode: AU fileFormats: - OASIS_UBL_XML - XML category: B2B processType: PEPPOLNetwork defaultFileFormats: 'null' - countryCode: AU fileFormats: - OASIS_UBL_XML - XML category: B2G processType: PEPPOLNetwork defaultFileFormats: 'null' success: true Validation Error#1: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: Mandate details are available only if Avalara is Integrated as service provider requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c schema: $ref: '#/components/schemas/EinvoiceFetchMandates' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List mandates for downloading files tags: - E-Invoicing /v1/invoices/{invoiceKey}/e-invoice/mandate: get: description: | Fetches mandates for downloading e-invoice based on the country code, category, and process type selection. **Note**: This operation is available only if you have the E-Invoicing feature for Avalara in **Early Availabiltiy** phase enabled. operationId: getEinvoiceMandateOnInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the invoice. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: Success: value: countryCode: AU fileFormats: - XML - OASIS_UBL_XM category: B2G defaultFileFormats: - XML processType: PEPPOLNetwork success: true Validation Error#1: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: E-Invoice for the document [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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create or update email templates tags: - Notifications /notifications/email-templates: post: description: | Creates an email template. This operation supports creating the email template for all event types. - If you specify the `eventCategory` field, the email template is created based on a standard event. See [Standard Event Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API) for all standard event category codes. - If you specify the `eventTypeName` field, the email template is created based on the corresponding custom event or custom scheduled event. See [Custom event triggers](https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/) for more information about custom events, and [Custom scheduled events](https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/) for more information about custom scheduled events. operationId: POST_Create_Email_Template parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPublicEmailTemplateRequest' description: The request body to create an email template. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicEmailTemplateResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: |- { "code":"ObjectNotFound", "message":"eventType {com.zuora.notification, AccountEdit} does not exist" } schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "code":"404", "message":"HTTP 404 Not Found" } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: |- { "code":"405", "message":"HTTP 405 Method Not Allowed" } schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: |- { "code":"415", "message":"HTTP 415 Unsupported Media Type" } schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "code":"500", "message":"A temporary problem in the service occurred, you can retry later." } schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an email template tags: - Notifications get: description: | Queries email templates. This operation supports querying email templates for all event types. operationId: GET_Query_Email_Templates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - allowEmptyValue: true description: The first index of the query result. in: query name: start schema: default: 1 format: int32 type: integer - allowEmptyValue: true description: The maximum number of results the query should return. in: query name: limit schema: default: 20 format: int32 maximum: 100 minimum: 1 type: integer - allowEmptyValue: true description: The event category code for standard events. in: query name: eventCategory schema: type: number - allowEmptyValue: true description: The name of the custom event or custom scheduled event. in: query name: eventTypeName schema: type: string - allowEmptyValue: true description: The name of the email template. in: query name: name schema: type: string responses: '200': content: application/json: examples: response: value: data: - active: true bccEmailAddress: user@example.com ccEmailAddress: user@example.com ccEmailType: SpecificEmails createdBy: 6e569e1e05f040eda51a927b140c0ac3 createdOn: '2017-04-18T07:36:19.798Z' description: Email when an account is edited emailBody: Dear user,
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: AccountHello,
\n\tYou have a pending approval. Please approve or reject.
\n\tThanks
\n' senderName: Admin senderEmail: workflow@zuora.com approvalNote: '' subjectEmail: This is the email to check if this email is working delivery_method: email email_approver_emails: - admin@company.com action_type: Approval object: '' object_id: '' call_type: SOAP task_id: null concurrent_limit: 9999999 tags: [] linkages: - source_workflow_id: 458 source_task_id: null target_task_id: 1418 linkage_type: Finish responses: '200': content: application/json: examples: response: value: id: 3373 name: Checking Workflow description: '' status: Active ondemandTrigger: true calloutTrigger: false scheduledTrigger: false interval: '' timezone: '' createdAt: '2024-11-15T12:51:45.859+08:00' updatedAt: '2024-11-15T12:51:45.859+08:00' active_version: id: 3373 description: '' type: Workflow::Setup version: 0.0.1 status: Inactive schema: $ref: '#/components/schemas/WorkflowDefinition' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Import a workflow version tags: - Workflows /workflows/workflow_runs/{workflow_run_id}/stop: put: tags: - Workflows summary: Stop a workflow run description: | Stop a specific workflow run by its ID. ### User Access Permission You must be assigned the **Workflow View Access** permission to run this operation. operationId: PUT_StopWorkflowRun parameters: - name: Accept-Encoding in: header description: | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. schema: type: string - name: Content-Encoding in: header description: | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. schema: type: string - name: Authorization in: header description: | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://developer.zuora.com/api-references/api/operation/createToken). required: true schema: type: string - name: Zuora-Entity-Ids in: header description: | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. schema: type: string - name: Zuora-Org-Ids in: header description: | Comma separated IDs. If you have [Zuora Multi-Org](https://knowledgecenter.zuora.com/Zuora_Central_Platform/Multi-Org) enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs. schema: type: string - name: Zuora-Track-Id in: header description: | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`). schema: maxLength: 64 type: string - name: workflow_run_id in: path description: | The unique ID of a workflow run. For example, 19080. required: true schema: type: string responses: '200': description: OK headers: RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string content: application/json: schema: $ref: '#/components/schemas/StopWorkflowRunSuccess' example: success: true '404': description: Cannot find a workflow run with id provided. headers: RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string content: application/json: schema: $ref: '#/components/schemas/StopWorkflowRunError' example: errors: - code: Invalid status: 404 title: Workflow run '19080' is not found /object-query/accounts: get: summary: List accounts description: | Lists accounts. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryAccounts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountnumber - balance - batch - billcycleday - billtoid - communicationprofileid - crmid - currency - defaultpaymentmethodid - invoicetemplateid - lastinvoicedate - name - parentid - shiptoid - soldtoid - status - in: query name: expand[] required: false schema: type: array items: type: string enum: - billto - soldto - shipto - defaultpaymentmethod - subscriptions - payments - refunds - creditmemos - debitmemos - invoices - usages - paymentmethods - subscriptions.rateplans - subscriptions.rateplans.rateplancharges description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountnumber - balance - batch - billcycleday - billtoid - communicationprofileid - crmid - currency - defaultpaymentmethodid - invoicetemplateid - lastinvoicedate - name - parentid - shiptoid - soldtoid - status - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: nextPage: W3sidmFsdWUiOiIyMDI0LTEyLTE2VDE3OjU1OjA1LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOWJlNDhkYjVhYmE3MDE4ZGI2MDQ3NzZkNDg1NCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0= data: - accountNumber: A00000130 allowInvoiceEdit: false autoPay: false balance: 7300 batch: Batch1 bcdSettingOption: ManualSet billCycleDay: 1 billToId: 8ad08eb292f6328c019318dcd45521b1 createdById: 2c92c0f972a852360172bbe22ac551b6 createdDate: '2024-11-10T17:35:45-08:00' creditBalance: 0 currency: USD id: 8ad08eb292f6328c019318dcd43821b0 invoiceDeliveryPrefsEmail: false invoiceDeliveryPrefsPrint: false invoiceTemplateId: 2c92c0f86cccaa59016cd5e0f500111d lastInvoiceDate: '2025-03-21' mrr: 2950 name: Bella Lawrence partnerAccount: false paymentMethodCascadingConsent: false paymentTerm: Net 30 soldToId: 8ad08eb292f6328c019318dcd47421b3 status: Active taxExemptStatus: 'No' totalDebitMemoBalance: 0 totalInvoiceBalance: 7300 unappliedBalance: 0 unappliedCreditMemoAmount: 0 updatedById: 2c92c0f972a852360172bbe22ac551b6 updatedDate: '2025-03-21T03:24:15-07:00' schema: type: object title: QueryAccountsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedAccount' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/accounts/{key}: get: summary: Retrieve an account description: | Retrieve the details of a specific Account object. operationId: queryAccountByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - billto - soldto - shipto - defaultpaymentmethod - subscriptions - payments - refunds - creditmemos - debitmemos - invoices - usages - paymentmethods - subscriptions.rateplans - subscriptions.rateplans.rateplancharges description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: accountNumber: A00000130 allowInvoiceEdit: false autoPay: false balance: 7300 batch: Batch1 bcdSettingOption: ManualSet billCycleDay: 1 billToId: 8ad08eb292f6328c019318dcd45521b1 createdById: 2c92c0f972a852360172bbe22ac551b6 createdDate: '2024-11-10T17:35:45-08:00' creditBalance: 0 currency: USD id: 8ad08eb292f6328c019318dcd43821b0 invoiceDeliveryPrefsEmail: false invoiceDeliveryPrefsPrint: false invoiceTemplateId: 2c92c0f86cccaa59016cd5e0f500111d lastInvoiceDate: '2025-03-21' mrr: 2950 name: Bella Lawrence partnerAccount: false paymentMethodCascadingConsent: false paymentTerm: Net 30 soldToId: 8ad08eb292f6328c019318dcd47421b3 status: Active taxExemptStatus: 'No' totalDebitMemoBalance: 0 totalInvoiceBalance: 7300 unappliedBalance: 0 unappliedCreditMemoAmount: 0 updatedById: 2c92c0f972a852360172bbe22ac551b6 updatedDate: '2025-03-21T03:24:15-07:00' schema: $ref: '#/components/schemas/ExpandedAccount' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/amendments: get: summary: List amendments description: | Lists amendments. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryAmendments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - code - effectivedate - effectivepolicy - name - newrateplanid - removedrateplanid - status - subscriptionid - type - subtype - updateddate - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Amendment object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - code - effectivedate - effectivepolicy - name - newrateplanid - removedrateplanid - status - subscriptionid - type - subtype - updateddate - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: nextPage: W3sidmFsdWUiOiIyMDI1LTAyLTA2VDIzOjA5OjExLTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmNmVhOWQ4Nzk0ZGE5Mzg2NGRmM2RiODU4MTcxOSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0= data: - bookingDate: '2025-02-01' code: A-AM00000890 contractEffectiveDate: '2025-02-01' createdById: 2c92c0f972a852360172bbe22ac551b6 createdDate: '2025-03-25T06:26:14-07:00' currentTermPeriodType: Month customerAcceptanceDate: '2025-02-01' effectiveDate: '2025-02-01' id: f94fb52490e95cd65925cd7b733100b7 name: auto generated renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTermPeriodType: Month serviceActivationDate: '2025-02-01' status: Completed type: Composite updatedById: 2c92c0f972a852360172bbe22ac551b6 updatedDate: '2025-03-25T06:26:14-07:00' schema: type: object title: QueryAmendmentsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedAmendment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/amendments/{key}: get: summary: Retrieve an amendment description: | Retrieve the details of a specific Amendment object. operationId: queryAmendmentByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Amendment object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: bookingDate: '2024-08-29' code: A-AM00000553 contractEffectiveDate: '2024-08-29' createdById: 8ad09fc28193c189018194da28be74ba createdDate: '2024-08-29T00:31:37-07:00' currentTerm: 12 currentTermPeriodType: Month customerAcceptanceDate: '2024-08-29' effectiveDate: '2024-08-29' id: 8ad097b49198384c01919d0c08d42c35 name: auto generated renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerm: 0 renewalTermPeriodType: Month serviceActivationDate: '2024-08-29' status: Completed subscriptionId: 8ad08ae29198249d01919d00a4c93b18 termStartDate: '2024-08-29' type: Cancellation updatedById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-29T00:31:37-07:00' schema: $ref: '#/components/schemas/ExpandedAmendment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/billing-runs: get: summary: List bill runs description: | Lists bill runs. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryBillingRuns parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - createdbyid - updateddate - billingrunnumber - executeddate - name - numberofaccounts - numberofinvoices - numberofcreditmemos - status - targetdate - batches - repeattype - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Bill Run object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - createdbyid - updateddate - billingrunnumber - executeddate - name - numberofaccounts - numberofinvoices - numberofcreditmemos - status - targetdate - batches - repeattype - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: nextPage: W3sidmFsdWUiOiIyMDI0LTA4LTI4VDIzOjA1OjA0LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkxOTgyNDkyMDE5MTljYjdmNWNjMjgxZSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0= data: - accountId: 2c92c0f87270a5970172747e289a5e66 autoEmail: false autoPost: false autoRenewal: true billingRunNumber: BR-00000005 billingRunType: Regular createdById: 2c92c0f97a98ca23017a990996124672 createdDate: '2022-04-25T19:08:32-07:00' endDate: '2022-04-25T19:08:37-07:00' executedDate: '2022-04-25T19:08:34-07:00' id: 8ad0887e805061c8018063a09fe2685a includeOrderLineItems: true includeSubscriptions: true invoiceDate: '2022-04-25' invoicesEmailed: false noEmailForZeroAmountInvoice: false numberOfAccounts: 1 numberOfCreditMemos: 0 numberOfInvoices: 1 startDate: '2022-04-25T19:08:34-07:00' status: Completed targetDate: '2022-07-30' targetType: SingleAccount totalTime: 3384 updatedById: 2c92c0f972a852360172bbe22ac551b6 updatedDate: '2025-02-06T23:10:15-08:00' schema: type: object title: QueryBillingRunsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedBillingRun' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/billing-runs/{key}: get: summary: Retrieve a bill run description: | Retrieve the details of a specific Bill Run object. operationId: queryBillingRunByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Bill Run object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: accountId: 2c92c0f87270a5970172747e289a5e66 autoEmail: false autoPost: false autoRenewal: true billingRunNumber: BR-00000005 billingRunType: Regular createdById: 2c92c0f97a98ca23017a990996124672 createdDate: '2022-04-25T19:08:32-07:00' endDate: '2022-04-25T19:08:37-07:00' executedDate: '2022-04-25T19:08:34-07:00' id: 8ad0887e805061c8018063a09fe2685a includeOrderLineItems: true includeSubscriptions: true invoiceDate: '2022-04-25' invoicesEmailed: false noEmailForZeroAmountInvoice: false numberOfAccounts: 1 numberOfCreditMemos: 0 numberOfInvoices: 1 startDate: '2022-04-25T19:08:34-07:00' status: Completed targetDate: '2022-07-30' targetType: SingleAccount totalTime: 3384 updatedById: 2c92c0f972a852360172bbe22ac551b6 updatedDate: '2025-02-06T23:10:15-08:00' schema: $ref: '#/components/schemas/ExpandedBillingRun' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/contacts: get: summary: List contacts description: | Lists contacts. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryContacts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - country - firstname - lastname - personalemail - workemail - workphone - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Contact object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - country - firstname - lastname - personalemail - workemail - workphone - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: nextPage: W3sidmFsdWUiOiIyMDI0LTExLTEwVDA0OjQ3OjM2LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODc1OTkyZjYzMjhlMDE5MzE2MWQ5MWEzMjdlNiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0= data: - accountId: 8ad087599521829e0195226d641312bd address1: 101 Redwood Shores Pkwy city: Redwood City country: United States createdById: 2c92c0f972a852360172bbe22ac551b6 createdDate: '2025-02-20T00:15:49-08:00' firstName: Amy id: 8ad087599521829e0195226d642112be lastName: Lawrence state: California updatedById: 2c92c0f972a852360172bbe22ac551b6 updatedDate: '2025-02-20T00:15:49-08:00' workEmail: amy.lawrence@zuora.com schema: type: object title: QueryContactsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedContact' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/contacts/{key}: get: summary: Retrieve a contact description: | Retrieve the details of a specific Contact object. operationId: queryContactByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Contact object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: accountId: 8ad087599521829e0195226d641312bd address1: 101 Redwood Shores Pkwy city: Redwood City country: United States createdById: 2c92c0f972a852360172bbe22ac551b6 createdDate: '2025-02-20T00:15:49-08:00' firstName: Amy id: 8ad087599521829e0195226d642112be lastName: Lawrence state: California updatedById: 2c92c0f972a852360172bbe22ac551b6 updatedDate: '2025-02-20T00:15:49-08:00' workEmail: amy.lawrence@zuora.com schema: $ref: '#/components/schemas/ExpandedContact' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memos: get: summary: List credit memos description: | Lists credit memos. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryCreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - balance - einvoicestatus - memodate - memonumber - sourcetype - status - totalamount - invoiceid - accountid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - billtocontact - billtocontactsnapshot - soldtocontactsnapshot - shiptocontactsnapshot - creditmemoitems - creditmemoitems.subscription - creditmemoitems.subscription.account - creditmemoapplications description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - balance - einvoicestatus - memodate - memonumber - sourcetype - status - totalamount - invoiceid - accountid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: nextPage: W3sidmFsdWUiOiIyMDI0LTA3LTIxVDIwOjEzOjQwLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODdkMjkwYzRiYjJhMDE5MGQ4NmUzNTkzNzAyZiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0= data: - accountId: 8ad09be48db5aba7018db604776d4854 appliedAmount: 112.43 autoApplyUponPosting: false balance: 0 billToContactId: 8ad09be48db5aba7018db60477a84855 createdById: 8ad09fc28193c189018194da28be74ba createdDate: '2024-08-28T23:32:58-07:00' currency: USD discountAmount: 0 exchangeRateDate: '2024-08-28' excludeFromAutoApplyRules: false id: 8ad097b49198384c01919cd658d21c46 invoiceId: 8ad084db909fae930190a12599477394 memoDate: '2024-09-27' memoNumber: CM00000013 postedById: 8ad09fc28193c189018194da28be74ba postedOn: '2024-08-28T23:32:58-07:00' reasonCode: Write-off refundAmount: 0 revenueImpacting: 'Yes' reversed: false sequenceSetId: 2c92c0f86cccaa59016cd5e0faa91145 source: AdhocFromInvoice sourceType: Invoice status: Posted taxAmount: 0 taxAutoCalculation: true totalAmount: 112.43 totalAmountWithoutTax: 112.43 totalTaxExemptAmount: 0 updatedById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-28T23:32:59-07:00' schema: type: object title: QueryCreditMemosResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedCreditMemo' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memos/{key}: get: summary: Retrieve a credit memo description: | Retrieve the details of a specific Credit Memo object. operationId: queryCreditMemoByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - billtocontact - billtocontactsnapshot - soldtocontactsnapshot - shiptocontactsnapshot - creditmemoitems - creditmemoitems.subscription - creditmemoitems.subscription.account - creditmemoapplications description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: accountId: 8ad09be48db5aba7018db604776d4854 appliedAmount: 112.43 autoApplyUponPosting: false balance: 0 billToContactId: 8ad09be48db5aba7018db60477a84855 createdById: 8ad09fc28193c189018194da28be74ba createdDate: '2024-08-28T23:32:58-07:00' currency: USD discountAmount: 0 exchangeRateDate: '2024-08-28' excludeFromAutoApplyRules: false id: 8ad097b49198384c01919cd658d21c46 invoiceId: 8ad084db909fae930190a12599477394 memoDate: '2024-09-27' memoNumber: CM00000013 postedById: 8ad09fc28193c189018194da28be74ba postedOn: '2024-08-28T23:32:58-07:00' reasonCode: Write-off refundAmount: 0 revenueImpacting: 'Yes' reversed: false sequenceSetId: 2c92c0f86cccaa59016cd5e0faa91145 source: AdhocFromInvoice sourceType: Invoice status: Posted taxAmount: 0 taxAutoCalculation: true totalAmount: 112.43 totalAmountWithoutTax: 112.43 totalTaxExemptAmount: 0 updatedById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-28T23:32:59-07:00' schema: $ref: '#/components/schemas/ExpandedCreditMemo' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memo-applications: get: summary: List credit memo applications description: | Lists credit memo applications. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryCreditMemoApplications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - effectivedate - accountid - applicationgroupid - debitmemoid - invoiceid - in: query name: expand[] required: false schema: type: array items: type: string enum: - creditmemo description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - effectivedate - accountid - applicationgroupid - debitmemoid - invoiceid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: nextPage: W3sidmFsdWUiOiIyMDI0LTA4LTE5VDIyOjU1OjExLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkxNjk4YjI4MDE5MTZlNWE4NTYyNTY1OCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0= data: - accountId: 8ad09be48db5aba7018db604776d4854 amount: 112.43 applicationGroupId: 8ad097b49198384c01919cd659b31c58 createdById: 8ad09fc28193c189018194da28be74ba createdDate: '2024-08-28T23:32:59-07:00' creditMemoId: 8ad097b49198384c01919cd658d21c46 effectiveDate: '2024-09-27' id: 8ad097b49198384c01919cd659be1c64 updatedById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-28T23:32:59-07:00' schema: type: object title: QueryCreditMemoApplicationsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedCreditMemoApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memo-applications/{key}: get: summary: Retrieve a credit memo application description: | Retrieve the details of a specific Credit Memo Application object. operationId: queryCreditMemoApplicationByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - creditmemo description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: accountId: 8ad09be48db5aba7018db604776d4854 amount: 112.43 applicationGroupId: 8ad097b49198384c01919cd659b31c58 createdById: 8ad09fc28193c189018194da28be74ba createdDate: '2024-08-28T23:32:59-07:00' creditMemoId: 8ad097b49198384c01919cd658d21c46 effectiveDate: '2024-09-27' id: 8ad097b49198384c01919cd659be1c64 updatedById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-28T23:32:59-07:00' schema: $ref: '#/components/schemas/ExpandedCreditMemoApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memo-items: get: summary: List credit memo items description: | Lists credit memo items. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryCreditMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - excludeitembillingfromrevenueaccounting - sourceitemtype - chargenumber - subscriptionid - subscriptionnumber - invoiceitemid - rateplanchargeid - creditmemoid - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - rateplancharge - subscriptionowner - credittaxationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - excludeitembillingfromrevenueaccounting - fulfillmentid - orderlineitemid - sourceitemtype - chargenumber - subscriptionid - subscriptionnumber - invoiceitemid - rateplanchargeid - creditmemoid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: nextPage: W3sidmFsdWUiOiIyMDI0LTA4LTE5VDIyOjU5OjU0LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkxNjk4YjI4MDE5MTZlNWE4NGU2NTY1NCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0= data: - accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206 amount: 105 amountWithoutTax: 105 appliedToOthersAmount: 105 beAppliedByOthersAmount: 0 chargeDate: '2024-08-28T23:32:58-07:00' chargeName: Monthly Fee createdById: 8ad09fc28193c189018194da28be74ba createdDate: '2024-08-28T23:32:58-07:00' creditFromItemId: 8ad084db909fae930190a12599697395 creditFromItemSource: InvoiceItem creditMemoId: 8ad097b49198384c01919cd658d21c46 deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213 excludeItemBillingFromRevenueAccounting: false id: 8ad097b49198384c01919cd659211c4a invoiceItemId: 8ad084db909fae930190a12599697395 numberOfDeliveries: 0 processingType: '0' productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38 quantity: 1 recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213 reflectDiscountInNetAmount: false revenueImpacting: 'Yes' serviceEndDate: '2024-07-11' serviceStartDate: '2024-07-11' sku: SKUE-00000026 sourceItemType: InvoiceDetail taxAmount: 0 taxExemptAmount: 0 taxMode: TaxExclusive unappliedAmount: 0 unitOfMeasure: '' unitPrice: 0 updatedById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-28T23:33:00-07:00' schema: type: object title: QueryCreditMemoItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedCreditMemoItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memo-items/{key}: get: summary: Retrieve a credit memo item description: | Retrieve the details of a specific Credit Memo Item object. operationId: queryCreditMemoItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - rateplancharge - subscriptionowner - credittaxationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206 amount: 105 amountWithoutTax: 105 appliedToOthersAmount: 105 beAppliedByOthersAmount: 0 chargeDate: '2024-08-28T23:32:58-07:00' chargeName: Monthly Fee createdById: 8ad09fc28193c189018194da28be74ba createdDate: '2024-08-28T23:32:58-07:00' creditFromItemId: 8ad084db909fae930190a12599697395 creditFromItemSource: InvoiceItem creditMemoId: 8ad097b49198384c01919cd658d21c46 deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213 excludeItemBillingFromRevenueAccounting: false id: 8ad097b49198384c01919cd659211c4a invoiceItemId: 8ad084db909fae930190a12599697395 numberOfDeliveries: 0 processingType: '0' productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38 quantity: 1 recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213 reflectDiscountInNetAmount: false revenueImpacting: 'Yes' serviceEndDate: '2024-07-11' serviceStartDate: '2024-07-11' sku: SKUE-00000026 sourceItemType: InvoiceDetail taxAmount: 0 taxExemptAmount: 0 taxMode: TaxExclusive unappliedAmount: 0 unitOfMeasure: '' unitPrice: 0 updatedById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-28T23:33:00-07:00' schema: $ref: '#/components/schemas/ExpandedCreditMemoItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/daily-consumption-summaries: get: summary: List daily consumption summaries description: | Lists daily consumption summaries. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryDailyConsumptionSummaries parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: schema: type: object title: QueryDebitMemoItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedDailyConsumptionSummary' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/daily-consumption-summaries/{key}: get: summary: Retrieve a daily consumption summary description: | Retrieve the details of a specific Daily Consumption Summary object. operationId: queryDailyConsumptionSummaryByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: chargeSegmentNumber: 2 createdById: '00000000000000000000000000000003' createdDate: '2024-02-28T01:36:50-08:00' dailyConsumptionAmount: 0 dailyGroupSummaryId: 1dc86d68f6095de88ad084f08858a719 dailyTotalQuantity: 45 id: 8ad093c18deeb97e018def12ea3b3fcb originChargeId: 8ad098317f3a75bf017f3edfbb402b57 ratingResultId: 8ad093c18deeb97e018def12ea353fca transactionDate: '2023-05-16' updatedById: '00000000000000000000000000000003' updatedDate: '2024-02-28T01:36:50-08:00' usageChargeName: usage-per unit usageChargeNumber: C-00000274 schema: $ref: '#/components/schemas/ExpandedDailyConsumptionSummary' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/debit-memos: get: summary: List debit memos description: | Lists debit memos. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryDebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - balance - creditmemoid - einvoicestatus - memodate - memonumber - sourcetype - status - totalamount - invoiceid - accountid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - billtocontact - billtocontactsnapshot - soldtocontactsnapshot - shiptocontactsnapshot - debitmemoitems - debitmemoitems.subscription - debitmemoitems.subscription.account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - balance - creditmemoid - einvoicestatus - memodate - memonumber - sourcetype - status - totalamount - invoiceid - accountid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: data: - accountId: 8ad09be48db5aba7018db604776d4854 autoPay: true balance: 10 createdById: b243314d594646d3b2651aeedd4be47e createdDate: '2024-08-19T23:14:11-07:00' currency: USD discountAmount: 0 dueDate: '2024-09-18' id: 8ad093789169a0c001916e6be7cf7113 memoDate: '2024-08-19' memoNumber: DM00000002 reasonCode: Correcting invoice error source: AdhocFromPrpc sourceType: Standalone status: Draft taxAmount: 0 taxAutoCalculation: true taxStatus: Complete totalAmount: 10 totalAmountWithoutTax: 10 totalTaxExemptAmount: 0 updatedById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-08-19T23:14:11-07:00' schema: type: object title: QueryDebitMemosResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedDebitMemo' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/debit-memos/{key}: get: summary: Retrieve a debit memo description: | Retrieve the details of a specific Debit Memo object. operationId: queryDebitMemoByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - billtocontact - billtocontactsnapshot - soldtocontactsnapshot - shiptocontactsnapshot - debitmemoitems - debitmemoitems.subscription - debitmemoitems.subscription.account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: accountId: 8ad09be48db5aba7018db604776d4854 autoPay: true balance: 10 createdById: b243314d594646d3b2651aeedd4be47e createdDate: '2024-08-19T23:14:11-07:00' currency: USD discountAmount: 0 dueDate: '2024-09-18' id: 8ad093789169a0c001916e6be7cf7113 memoDate: '2024-08-19' memoNumber: DM00000002 reasonCode: Correcting invoice error source: AdhocFromPrpc sourceType: Standalone status: Draft taxAmount: 0 taxAutoCalculation: true taxStatus: Complete totalAmount: 10 totalAmountWithoutTax: 10 totalTaxExemptAmount: 0 updatedById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-08-19T23:14:11-07:00' schema: $ref: '#/components/schemas/ExpandedDebitMemo' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/debit-memo-items: get: summary: List debit memo items description: | Lists debit memo items. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryDebitMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - creditmemoitemid - excludeitembillingfromrevenueaccounting - sourceitemtype - chargenumber - subscriptionid - subscriptionnumber - invoiceitemid - productrateplanchargeid - rateplanchargeid - debitmemoid - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - rateplancharge - subscriptionowner - debittaxationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - creditmemoitemid - excludeitembillingfromrevenueaccounting - sourceitemtype - chargenumber - subscriptionid - subscriptionnumber - invoiceitemid - productrateplanchargeid - rateplanchargeid - debitmemoid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: data: - accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206 amount: 10 amountWithoutTax: 10 appliedToOthersAmount: 0 balance: 10 beAppliedByOthersAmount: 0 chargeDate: '2024-08-19T23:14:11-07:00' chargeName: Monthly Fee createdById: b243314d594646d3b2651aeedd4be47e createdDate: '2024-08-19T23:14:11-07:00' debitMemoId: 8ad093789169a0c001916e6be7cf7113 deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213 description: '' excludeItemBillingFromRevenueAccounting: false id: 8ad093789169a0c001916e6be8127114 itemSoldToContactId: 8ad09be48db5aba7018db60477a84855 processingType: '0' productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38 quantity: 1 recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213 serviceEndDate: '2030-04-01' serviceStartDate: '2024-05-21' sku: SKUE-00000026 sourceItemType: ProductRatePlanCharge taxAmount: 0 taxExemptAmount: 0 unitOfMeasure: '' unitPrice: 10 updatedById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-08-19T23:14:11-07:00' schema: type: object title: QueryDebitMemoItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedDebitMemoItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/debit-memo-items/{key}: get: summary: Retrieve a debit memo item description: | Retrieve the details of a specific Debit Memo Item object. operationId: queryDebitMemoItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - rateplancharge - subscriptionowner - debittaxationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206 amount: 10 amountWithoutTax: 10 appliedToOthersAmount: 0 balance: 10 beAppliedByOthersAmount: 0 chargeDate: '2024-08-19T23:14:11-07:00' chargeName: Monthly Fee createdById: b243314d594646d3b2651aeedd4be47e createdDate: '2024-08-19T23:14:11-07:00' debitMemoId: 8ad093789169a0c001916e6be7cf7113 deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213 description: '' excludeItemBillingFromRevenueAccounting: false id: 8ad093789169a0c001916e6be8127114 itemSoldToContactId: 8ad09be48db5aba7018db60477a84855 processingType: '0' productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38 quantity: 1 recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213 serviceEndDate: '2030-04-01' serviceStartDate: '2024-05-21' sku: SKUE-00000026 sourceItemType: ProductRatePlanCharge taxAmount: 0 taxExemptAmount: 0 unitOfMeasure: '' unitPrice: 10 updatedById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-08-19T23:14:11-07:00' schema: $ref: '#/components/schemas/ExpandedDebitMemoItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/delivery-adjustments: get: summary: List delivery adjustments description: | Lists Delivery Adjustment objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryDeliveryAdjustments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - adjustmentnumber - creditmemonumber - creditmemoid - debitmemonumber - segmentid - chargeid - chargenumber - subscriptionid - subscriptionnumber - originalsubid - accountid - invoiceowneraccountid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - adjustmentnumber - creditmemonumber - creditmemoid - debitmemonumber - segmentid - chargeid - chargenumber - subscriptionid - subscriptionnumber - originalsubid - accountid - invoiceowneraccountid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: nextPage: W3sidmFsdWUiOiIyMDI0LTAzLTE5VDE1OjMzOjAzKzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YTkwYTA0ZDhlNTU0ODNkMDE4ZTU1YTBjNzY4NDRiZSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0= data: - accountId: 8a90f13b8da1afeb018da27a1e7c1122 adjustmentNumber: ADJ-00000209 amount: -1.7 amountPerUnit: 1.7 billingDate: '2025-05-19' chargeId: edcad42faf796eabde76eb9b87e30028 chargeNumber: C-00034922 createdById: 2c92c8f95e2d6ebb015e325df48e02da createdDate: '2025-05-20T10:55:40+08:00' creditMemoId: 8a90def796ead18a0196eb9e47164124 creditMemoNumber: CM00000698 date: '2025-05-12' deferredAccountingCode: '' deliveryDay: monday id: 8a90def796ead18a0196eb9e465b4123 invoiceOwnerAccountId: 8a90f13b8da1afeb018da27a1e7c1122 numberOfDeliveries: 1 originalSubId: edcad42faf796eabde76eb9b87e30026 reason: '' recognizedRevenueAccountingCode: '' revenueRecognitionRuleName: '' segmentId: edcad42faf796eabde76eb9b87e30028 status: Billed subscriptionId: edcad42faf796eabde76eb9b87e30026 subscriptionNumber: A-S00004451 type: DeliveryCredit updatedById: 2c92c8f95e2d6ebb015e325df48e02da updatedDate: '2025-05-20T10:55:40+08:00' schema: properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedDeliveryAdjustment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/delivery-adjustments/{key}: get: summary: Retrieve a delivery adjustment description: | Retrieves a Delivery Adjustment object. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryDeliveryAdjustmentByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string description: | ID or number of the delivery adjustment. - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields include: - id - adjustmentnumber - creditmemonumber - creditmemoid - debitmemonumber - segmentid - chargeid - chargenumber - subscriptionid - subscriptionnumber - originalsubid - accountid - invoiceowneraccountid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields include: - id - adjustmentnumber - creditmemonumber - creditmemoid - debitmemonumber - segmentid - chargeid - chargenumber - subscriptionid - subscriptionnumber - originalsubid - accountid - invoiceowneraccountid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: accountId: 8a90f13b8da1afeb018da27a1e7c1122 adjustmentNumber: ADJ-00000209 amount: -1.7 amountPerUnit: 1.7 billingDate: '2025-05-19' chargeId: edcad42faf796eabde76eb9b87e30028 chargeNumber: C-00034922 createdById: 2c92c8f95e2d6ebb015e325df48e02da createdDate: '2025-05-20T10:55:40+08:00' creditMemoId: 8a90def796ead18a0196eb9e47164124 creditMemoNumber: CM00000698 date: '2025-05-12' deferredAccountingCode: '' deliveryDay: monday id: 8a90def796ead18a0196eb9e465b4123 invoiceOwnerAccountId: 8a90f13b8da1afeb018da27a1e7c1122 numberOfDeliveries: 1 originalSubId: edcad42faf796eabde76eb9b87e30026 reason: '' recognizedRevenueAccountingCode: '' revenueRecognitionRuleName: '' segmentId: edcad42faf796eabde76eb9b87e30028 status: Billed subscriptionId: edcad42faf796eabde76eb9b87e30026 subscriptionNumber: A-S00004451 type: DeliveryCredit updatedById: 2c92c8f95e2d6ebb015e325df48e02da updatedDate: '2025-05-20T10:55:40+08:00' schema: $ref: '#/components/schemas/ExpandedDeliveryAdjustment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/fulfillments: get: summary: List fulfillments description: | Lists Fulfillment objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryFulfillments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - updateddate - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - createddate - updateddate - orderlineitemid - fulfillmentnumber - state - externalid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: nextPage: W3sidmFsdWUiOiIyMDI0LTExLTEzVDIzOjA0OjQ5KzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YTkwZDdhODkzMjU2ZGZkMDE5MzI2MGU0NWNiMDBkYiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0= data: - billTargetDate: '2025-07-14' createdById: a0933229dfcd41f3a977efa52be31667 createdDate: '2025-07-14T12:01:58+08:00' excludeItemBillingFromRevenueAccounting: false excludeItemBookingFromRevenueAccounting: false fulfillmentDate: '2025-07-14' fulfillmentNumber: F-00000166 fulfillmentType: Delivery id: 8a90f48297fbc4bf01980718bd9a0034 orderLineItemId: 8a90ff9297fbc4ee01980714649212d6 quantity: 100 state: SentToBilling updatedById: a0933229dfcd41f3a977efa52be31667 updatedDate: '2025-07-14T12:01:58+08:00' schema: properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedFulfillment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/fulfillments/{key}: get: summary: Retrieve a fulfillment description: | Retrieves a Fulfillment object. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryFulfillmentByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - in: path name: key required: true schema: type: string description: | ID or number of the fulfillment. - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - updateddate - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - createddate - updateddate - orderlineitemid - fulfillmentnumber - state - externalid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: billTargetDate: '2025-07-14' createdById: a0933229dfcd41f3a977efa52be31667 createdDate: '2025-07-14T12:01:58+08:00' excludeItemBillingFromRevenueAccounting: false excludeItemBookingFromRevenueAccounting: false fulfillmentDate: '2025-07-14' fulfillmentNumber: F-00000166 fulfillmentType: Delivery id: 8a90f48297fbc4bf01980718bd9a0034 orderLineItemId: 8a90ff9297fbc4ee01980714649212d6 quantity: 100 state: SentToBilling updatedById: a0933229dfcd41f3a977efa52be31667 updatedDate: '2025-07-14T12:01:58+08:00' schema: $ref: '#/components/schemas/ExpandedFulfillment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: example: reasons: - code: 50000060 message: An unexpected error occurred. Please try again or reach out to Zuora Support requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Internal server error headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: example: reasons: - code: 50000027 message: 'Invalid filter parameter: id' requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/invoices: get: summary: List invoices description: | Lists invoices. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - amount - balance - duedate - invoicedate - invoicenumber - reversed - sourceid - sourcetype - status - einvoicestatus - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - account.billto - account.soldto - account.shipto - billtocontact - billtocontactsnapshot - soldtocontactsnapshot - shiptocontactsnapshot - invoiceitems - invoiceitems.subscription - invoiceitems.subscription.account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - amount - balance - duedate - invoicedate - invoicenumber - reversed - sourceid - sourcetype - status - einvoicestatus - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate - in: query name: includeNullFields required: false schema: type: boolean default: false description: | Specifies whether to include fields with the `null` value in the response. - If set to `true`, all fields will be returned in the response, including those with the `null` value. - If set to `false`, only fields with non-null values will be returned. responses: '200': content: application/json: example: nextPage: MTA= data: - accountId: 8ad0875995a3ed800195a43a2ea40437 adjustmentAmount: 0 amount: 7300 amountWithoutTax: 7300 autoPay: true balance: 7300 billToContactId: 8ad0875995a3ed800195a43a2ed30438 comments: '' createdById: 2c92c0f972a852360172bbe22ac551b6 createdDate: '2025-03-21T01:42:47-07:00' creditBalanceAdjustmentAmount: 0 creditMemoAmount: 0 currency: USD dueDate: '2025-04-20' id: 8ad0875995aa292e0195b7de80796305 includesOneTime: true includesRecurring: true includesUsage: true invoiceDate: '2025-03-21' invoiceNumber: INV00000255 paymentAmount: 0 paymentTerm: Net 30 postedBy: 2c92c0f972a852360172bbe22ac551b6 postedDate: '2025-03-21T01:42:47-07:00' refundAmount: 0 reversed: false sequenceSetId: 2c92c0f86cccaa59016cd5e0faa91145 source: API sourceType: Subscription status: Posted targetDate: '2025-03-21' taxAmount: 0 taxExemptAmount: 0 templateId: 2c92c0f86cccaa59016cd5e0f500111d updatedById: 2c92c0f972a852360172bbe22ac551b6 updatedDate: '2025-03-21T01:42:47-07:00' schema: type: object title: QueryInvoicesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedInvoice' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'