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/).
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: |
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 [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation is used to create an account with a credit card payment method, a bill-to contact, and optionally an sold-to contact or an associated subscription. If you want to create an account without creating any associated objects such as subscriptions, use [CRUD: Create Account](https://developer.zuora.com/api-references/api/operation/Object_POSTAccount) instead.
If you want to create an account and the associated subscription at the same time without providing credit card information, use the [Subscribe](https://developer.zuora.com/api-references/api/operation/Action_POSTsubscribe) action.
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: |
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: |
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 Jobs API operations allow you to manage bulk data loader services and perform programmatic CRUD (Create, Update, Read/export, Delete) operations.
name: Bulk Jobs
- description: |
Every time a contact is updated a snapshot is taken.
name: Contact Snapshots
- 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 [Custom Objects API error code](https://knowledgecenter.zuora.com/Central_Platform/Custom_Objects/Z_Custom_Objects_API#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](https://knowledgecenter.zuora.com/Central_Platform/Custom_Objects/Z_Custom_Objects_API#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](https://knowledgecenter.zuora.com/Central_Platform/Custom_Objects/Z_Custom_Objects_API#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.
**NOTE:** Notifications are processed asynchronously and may be delivered with a delay and out of order.
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: |
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 more comprehensive introduction to these fields and the Object Queries limitations, 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.
**Note**: The Object Query API is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available.
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: |
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.
The 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: |
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: |
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: |
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: |
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: |
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.
name: Zuora Revenue Integration
paths:
/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'
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_HEADER_Authorization_OAuth_optional'
- $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'
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_Authorization_OAuth_optional'
- $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
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_HEADER_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_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'
- description: |
The minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
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_Authorization_OAuth_optional'
- $ref: '#/components/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 minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
- 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
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_Authorization_OAuth_optional'
- $ref: '#/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/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_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_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'
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_Authorization_OAuth_optional'
- $ref: '#/components/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
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_Authorization_OAuth_optional'
- $ref: '#/components/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
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_Authorization_OAuth_optional'
- $ref: '#/components/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
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_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_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
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_Authorization_OAuth_optional'
- $ref: '#/components/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
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_Authorization_OAuth_optional'
- $ref: '#/components/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
responses:
'200':
content:
application/json:
examples:
response:
value:
- description: ''
effectiveEndDate: '2023-01-01'
effectiveStartDate: '2022-01-01'
externalIdSourceSystem: apple
externallyManagedPlanIds:
- a
id: 2c989020823f450c01823fef40421eb6
name: My rate plan 072706
status: Active
- description: ''
effectiveEndDate: '2023-01-01'
effectiveStartDate: '2022-01-01'
externalIdSourceSystem: apple
externallyManagedPlanIds:
- a
id: 2c989020823f450c01823fede57d1eb5
name: My rate plan 072705
status: Active
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_HEADER_Authorization_OAuth_optional'
- $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'
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_Authorization_OAuth_optional'
- $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
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_HEADER_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
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_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $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
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_HEADER_Authorization_OAuth_optional'
- $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'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyCreateProductRatePlanCharge'
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_Authorization_OAuth_optional'
- $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
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_HEADER_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
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_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
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_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
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_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth_optional'
- $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
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_HEADER_Authorization_OAuth_optional'
- $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
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_Authorization_OAuth'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
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
/v1/accounts:
post:
description: |
Creates a customer account with a payment method, a bill-to contact, and an optional sold-to contact. 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 |
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_Authorization_OAuth_optional'
- $ref: '#/components/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 minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
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_Authorization_OAuth_optional'
- $ref: '#/components/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
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_Authorization_OAuth_optional'
- $ref: '#/components/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
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 and sold-to contacts are separate data entities. If you select the **Same as Bill To Contact** check box during account creation, both the Bill To and Sold To contacts are updated upon updating either one because they point to the same contact record. In this case, if you want to update only one of them, you have to first create another contact and update the Bill To or Sold To contact of the customer account to be 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_Authorization_OAuth_optional'
- $ref: '#/components/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
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_Authorization_OAuth_optional'
- $ref: '#/components/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
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_Authorization_OAuth_optional'
- $ref: '#/components/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
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_Authorization_OAuth_optional'
- $ref: '#/components/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
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.
**Note:** This operation also supports retrieving the custom payment method created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service.
operationId: GET_AcountDefaultPaymentMethod
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Account number or account ID.
in: path
name: account-key
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
AA_PICKLIST__c: null
accountHolderInfo:
accountHolderName: John Smith
addressLine1: ABC
addressLine2: EFT
city: Example City
country: United States
email: example@google.com
phone: '86123456789'
state: Example State
zipCode: '844000'
accountKey: 4028839f7ca29000017ca29c1ce8003f
bankIdentificationNumber: '411111'
cardNumber: '************1111'
createdBy: 402881e522cf4f9b0122cf5d82860002
createdDate: '2021-11-15 18:59:08'
creditCardType: Visa
deviceSessionId: null
existingMandate: null
expirationMonth: 11
expirationYear: 2027
id: 4028839f7d26a155017d26af16ef0001
identityNumber: '97370192024'
ipAddress: null
isDefault: true
lastFailedSaleTransactionDate: null
lastTransaction: Approved
lastTransactionDateTime: '2021-11-15 18:59:08'
lastTransactionStatus: Approved
mandateInfo:
mitConsentAgreementRef: null
mitConsentAgreementSrc: null
mitProfileAction: null
mitProfileAgreedOn: null
mitProfileType: null
mitTransactionId: null
maxConsecutivePaymentFailures: null
numConsecutiveFailures: 0
paymentRetryWindow: null
status: Active
success: true
totalNumberOfErrorPayments: 0
totalNumberOfProcessedPayments: 0
type: CreditCard
updatedBy: 402881e522cf4f9b0122cf5d82860002
updatedDate: '2021-11-15 18:59:08'
useDefaultRetryRule: true
schema:
$ref: '#/components/schemas/GETPaymentMethodResponseForAccount'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve the default payment method of an account
tags:
- Accounts
/v1/accounts/{account-key}/summary:
get:
description: |
Retrieves detailed information about the specified customer account.
The response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages.
### Notes
Returns only the six most recent subscriptions based on the subscription updatedDate. Within those subscriptions, there may be many rate plans and many rate plan charges. These items are subject to the maximum limit on the array size.
operationId: GET_AccountSummary
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Account number or account ID.
in: path
name: account-key
required: true
schema:
type: string
- description: Indicate whether to exclude usage information in the response. The default value is `false`.
in: query
name: excludeUsage
required: false
schema:
type: boolean
responses:
'200':
content:
application/json:
examples:
response:
value:
basicInfo:
accountNumber: A00001115
additionalEmailAddresses:
- contact1@example.com
- contact2@example.com
autoPay: true
balance: 0
billCycleDay: 1
currency: USD
defaultPaymentMethod:
creditCardExpirationMonth: 10
creditCardExpirationYear: 2020
creditCardNumber: '************1111'
creditCardType: Visa
id: 2c92c8f83dabf9cf013daef12dd303b0
paymentMethodType: CreditCard
id: 2c92a0f9391832b10139183e277a0042
invoiceDeliveryPrefsEmail: true
invoiceDeliveryPrefsPrint: false
lastInvoiceDate: '2013-02-11'
lastPaymentAmount: 150248.1
lastPaymentDate: '2013-03-27'
name: subscribeCallYan_1
partnerAccount: false
paymentMethodCascadingConsent: false
status: Active
billToContact:
address1: 1400 Bridge Pkwy
address2: ''
city: San Jose
country: United States
county: ''
fax: ''
firstName: Cheng
id: 2c92a0f9391832b10139183e27940043
lastName: Zou
state: California
taxRegion: ''
workEmail: contact@example.com
workPhone: '5555551212'
zipCode: '95135'
invoices:
- amount: 139722.1
balance: 0
dueDate: '2013-02-11'
id: 2c92a0953a3fa95d013a407c10a60100
invoiceDate: '2013-02-11'
invoiceNumber: INV00000323
status: Posted
- amount: 10521
balance: 0
dueDate: '2012-08-11'
id: 2c92a09739190dc60139194bcf1b0098
invoiceDate: '2012-08-11'
invoiceNumber: INV00000160
status: Posted
- amount: 10
balance: 0
dueDate: '2012-08-11'
id: 2c92a09539190dbe0139190f42780012
invoiceDate: '2012-08-11'
invoiceNumber: INV00000159
status: Posted
payments:
- effectiveDate: '2013-03-27'
id: 2c92c8f83dabf9cf013daf3bfa0305a6
paidInvoices:
- appliedPaymentAmount: 5
invoiceId: 2c92a09539190dbe0139190f42780012
invoiceNumber: INV00000159
- appliedPaymentAmount: 139722.1
invoiceId: 2c92a0953a3fa95d013a407c10a60100
invoiceNumber: INV00000323
- appliedPaymentAmount: 10521
invoiceId: 2c92a09739190dc60139194bcf1b0098
invoiceNumber: INV00000160
paymentNumber: P-00000075
paymentType: Electronic
status: Processed
- effectiveDate: '2012-08-11'
id: 2c92a0f9391832b101391922ad5f049d
paidInvoices:
- appliedPaymentAmount: 5
invoiceId: 2c92a09539190dbe0139190f42780012
invoiceNumber: INV00000159
paymentNumber: P-00000056
paymentType: Electronic
status: Processed
soldToContact:
address1: 278 Bridgeton Circle
address2: ''
city: San Jose
country: United States
county: ''
fax: ''
firstName: Bill
id: 2c92a0f9391832b10139183e27940043
lastName: Cho
state: California
taxRegion: ''
workEmail: contact@example.com
workPhone: '5555551212'
zipCode: '95135'
subscriptions:
- autoRenew: true
id: 2c92c8f83dc4f752013dc72c24ee016d
initialTerm: 12
ratePlans:
- productName: Recurring Charge
ratePlanName: QSF_Tier
renewalTerm: 3
status: Active
subscriptionNumber: A-S00001081
subscriptionStartDate: '2013-02-01'
termEndDate: '2014-02-01'
termStartDate: '2013-02-01'
termType: TERMED
- autoRenew: true
id: 2c92c8f83dc4f752013dc72bb85c0127
initialTerm: 12
ratePlans:
- productName: Recurring Charge
ratePlanName: QSF_Tier
renewalTerm: 3
status: Active
subscriptionNumber: A-S00001080
subscriptionStartDate: '2013-02-01'
termEndDate: '2014-02-01'
termStartDate: '2013-02-01'
termType: TERMED
- autoRenew: false
id: 2c92c8f83dc4f752013dc723fdab00d4
initialTerm: 10
ratePlans:
- productName: Recurring Charge
ratePlanName: QSF_Tier
renewalTerm: 4
status: Cancelled
subscriptionNumber: A-S00001079
subscriptionStartDate: '2013-02-01'
termEndDate: '2014-04-01'
termStartDate: '2013-12-01'
termType: TERMED
- autoRenew: false
id: 2c92c8f83db0b4b4013db4717ad000ec
initialTerm: 12
ratePlans:
- productName: Recurring Charge
ratePlanName: Month_PerUnit
- productName: Recurring Charge
ratePlanName: Month_PerUnit
renewalTerm: 3
status: Active
subscriptionNumber: A-S00001076
subscriptionStartDate: '2011-02-11'
termEndDate: '2012-02-11'
termStartDate: '2011-02-11'
termType: TERMED
- autoRenew: false
id: 2c92c8f83db0b4b4013db3ab6a4d00bc
initialTerm: 12
ratePlans:
- productName: Recurring Charge
ratePlanName: Month_PerUnit
- productName: Recurring Charge
ratePlanName: Month_PerUnit
renewalTerm: 3
status: Active
subscriptionNumber: A-S00001075
subscriptionStartDate: '2011-02-11'
termEndDate: '2012-02-11'
termStartDate: '2011-02-11'
termType: TERMED
- autoRenew: false
id: 2c92c8f83db0b4b4013db3aa9fbd0090
initialTerm: 12
ratePlans:
- productName: Recurring Charge
ratePlanName: Month_PerUnit
renewalTerm: 3
status: Active
subscriptionNumber: A-S00001074
subscriptionStartDate: '2011-02-11'
termEndDate: '2012-02-11'
termStartDate: '2011-02-11'
termType: TERMED
success: true
usage:
- quantity: 10
startDate: 2012-02
unitOfMeasure: UOM
- quantity: 10
startDate: 2012-01
unitOfMeasure: UOM
schema:
$ref: '#/components/schemas/GETAccountSummaryType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve an account summary
tags:
- Accounts
/v1/contacts:
post:
description: |
Creates a contact for a specified account.
operationId: POST_CreateContact
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTContactType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
accountId: 6e767220676e6e61206776652075207570
accountNumber: A00000001
address1: 314, Bongora
address2: near Tech City
city: GHY
contactDescription: This is a description for the contact
country: India
county: null
fax: '6174'
firstName: Kuhi
homePhone: '1234123'
id: 6b65657020726f6c6c696e672021
lastName: Das
mobilePhone: '123213'
nickname: Dorimi
otherPhone: '2314213'
otherPhoneType: Work
personalEmail: kuhiroll@example.com
state: Assam
success: true
taxRegion: California
workEmail: amy.lawrence@zuora.com
workPhone: (888) 976-9056
zipCode: '123456'
schema:
$ref: '#/components/schemas/ContactResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Create a contact
tags:
- Contacts
/v1/contacts/{contactId}:
delete:
description: |
Deletes a contact.
operationId: DELETE_Contact
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- description: |
The ID of the contact that you want to delete.
in: path
name: contactId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Delete a contact
tags:
- Contacts
get:
description: |
Retrieves detailed information about a specific contact.
operationId: GET_Contact
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- description: |
The ID of the contact that you want to retrieve.
in: path
name: contactId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
accountId: 72756e2061726e642026206465736572742075
accountNumber: A00000001
address1: 567, Rose Apartment
address2: Gate no. 2
city: Seattle
contactDescription: This is a description
country: United States
county: King County
fax: '123456'
firstName: peter
homePhone: '86123456789'
id: 402881a2889f2e4301889f30e64e0019
lastName: parker
mobilePhone: '1234567890'
nickname: peet
otherPhone: '11111111111111111'
otherPhoneType: Work
personalEmail: peet@example.com
state: Washington
success: true
taxRegion: CA
workEmail: work.mail@example.com
workPhone: '3432'
zipCode: '123134'
schema:
$ref: '#/components/schemas/ContactResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a contact
tags:
- Contacts
put:
description: |
Updates a contact for a specified account.
You can update contacts for cancelled accounts.
operationId: PUT_Contact
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- description: |
The ID of the contact that you want to update.
in: path
name: contactId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTContactType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
accountId: 6e767220676e6e61206d616b65207520637279
accountNumber: A00000001
address1: new Address
address2: near Tech City
city: Mumbai
contactDescription: This is the new Description
country: India
county: null
fax: '6174'
firstName: Kuhi
homePhone: '1234123'
id: 8a90f50888a3036e0188ab7b3ffe7b8a
lastName: Das
mobilePhone: '123213'
nickname: Dorimi
otherPhone: '2314213'
otherPhoneType: Work
personalEmail: kuhiroll@example.com
state: Assam
success: true
taxRegion: California
workEmail: amy.lawrence@zuora.com
workPhone: (888)976-9056
zipCode: '123134'
schema:
$ref: '#/components/schemas/ContactResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update a contact
tags:
- Contacts
/v1/contacts/{contactId}/scrub:
put:
description: |
Scrubs the sensitive data of a specific contact.
You can use this operation to replace all sensitive data in a contact and its related contact snapshot with dummy values that will be stored in Zuora databases.
After scrubbing a contact, it is good practice to delete it. Otherwise, it might cause errors in subsequent operations.
**Note**: To use this operation, you must ensure that the "Scrub Sensitive Data of Contact" billing permission is enabled in your user role. Contact your tenant administrator if you want to enable this permission. See [Scrub Contacts](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/A_How_to_Manage_Customer_Accounts/B_Key_Contacts/Scrub_Contacts) for more information.
operationId: PUT_ScrubContact
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- description: |
The ID of the contact that you want to scrub sensitive data from.
in: path
name: contactId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Scrub a contact
tags:
- Contacts
/v1/contact-snapshots/{contact-snapshot-id}:
get:
description: |
Retrieves detailed information about the snapshot of a contact, either a bill-to contact or sold-to contact.
operationId: GET_ContactSnapshot
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_REQUEST_page'
- $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
- description: |
The unique ID of the contact snapshot to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab.
in: path
name: contact-snapshot-id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
address1: 4th street Custom colony
address2: Thoraipakkam
city: Chennai
contactId: 4028c7628741ebe3018745f2c4123514
country: India
county: null
description: null
fax: 43212
firstName: Pat
homePhone: 9877
id: 4028c7628741ebe3018745f2c4133515
lastName: Parker
mobilePhone: '1234567890'
nickname: this is a nick name
otherPhone: '9876543210'
otherPhoneType: Work
personalEmail: test123@gmail.com
postalCode: 123456
state: TN
success: true
taxRegion: California
workEmail: amy.lawrence@zuora.com
workPhone: (888)976-9056
schema:
$ref: '#/components/schemas/GETContactSnapshotResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a contact snapshot
tags:
- Contact Snapshots
/v1/sign-up:
post:
description: |
This call performs many actions. You can use this operation to implement the standard requirements for signing up a customer, such as validating the uniqueness of an account and limiting the number of subscriptions per account. Also, you can use this operation to create a subscription, generate an invoice, and collect payment for a new or existing customer.
**Note:** You need to have the [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders/Orders_Harmonization) feature enabled to use this API.
For a new customer, you can perform the following tasks in one call. Note that you can skip creating a payment meethod and still get the subscription and invoice successfully created.
* Create an account
* Create a payment method
* Subscribe to a product in the product catalog and create a subscription
* Generate an invoice
* Collect payment
For an existing customer, you can use an account identification field of an external system to specify the account.
You can make [make asynchronous requests](https://developer.zuora.com/rest-api/general-concepts/async-requests/) when using the "Sign up" operation.
operationId: POST_SignUp
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Charge_Metrics_Accept'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SignUpRequest'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
accountId: 4028818284f5f8130184f5fe1e9011e8
accountNumber: A00000001
invoiceId: 4028818284f5f8130184f5fe23b8120c
invoiceNumber: INV00000001
orderNumber: O-00000001
paidAmount: 300
paymentId: 4028818284f5f8130184f5fe24b71218
paymentNumber: P-00000001
status: Completed
subscriptionId: 4028818284f5f8130184f5fe214611f3
subscriptionNumber: A-S00000001
success: true
schema:
$ref: '#/components/schemas/SignUpResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Sign up
tags:
- Sign Up
/v1/orders/preview:
post:
description: |
**Notes**:
- This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable
Orders Harmonization to access the Orders feature. With Orders, you can access both existing
functions for subscription and billing management and the new features on Zuora Billing.
- The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
feature is now generally available to all Zuora customers. You need to enable
the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
feature. As of Zuora Billing Release 313 (November 2021), new customers who
onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders)
will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
feature enabled by default.
- You cannot preview enhanced discounts and usage charges.
- You can skip the accounting period validation to avoid backdated subscription cancellation caused order preview failure. To skip the accounting period validation, submit a request at Zuora Global Support.
Retrieves the preview of the charge metrics and invoice items of a specified order. Preview for subscriptions and order line items are both supported. This operation is only an order preview and no order is created.
You can also use this operation to preview billing for a standalone order. For more information, see Preview billing for a standalone order.
#### Billing preview behavior regarding draft invoices
By default, the billing preview behavior regarding draft invoices is as below:
- When you preview billing for your order and the order contains subscriptions only, the draft invoices are excluded.
- When you preview billing for your order and the order contains order line items only, the draft invoices are included.
- When you preview billing for an order that contains both subscriptions order line items, the draft invoices are included for both subscriptions and order line items.
However, if you want to always exclude the draft invoices in billing preview, submit a request at Zuora Global Support.
#### Limits on Orders API
The limit of orders allowed on a subscription is 1000.
The limit of order line items allowed in an order is 100.
Zuora has the following limits on the Orders synchronous API to prevent performance degradation:
- Up to 50 subscriptions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
- Up to 50 order actions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
- Up to 50 order actions are allowed on a single subscription in a [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:
- [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
- [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
- [Retrieve the status and response of a job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse)
for checking the status of the asynchronous API operations
Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:
- Up to 300 subscriptions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
operation call.
- Up to 300 order actions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.
- Up to 300 order actions are allowed on a single subscription\
in a [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
operation call.
operationId: POST_PreviewOrder
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/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/POSTOrderPreviewRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
previewResult:
invoices:
- amount: 14.99
amountWithoutTax: 14.99
taxAmount: 0
targetDate: '2024-07-31'
invoiceItems:
- serviceStartDate: '2024-07-01'
serviceEndDate: '2024-07-31'
amountWithoutTax: 14.99
taxAmount: 0
chargeDescription: ''
chargeName: Monthly Fee
chargeNumber: null
processingType: Charge
productName: Music Service
productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38
unitPrice: 14.99
subscriptionNumber: null
orderLineItemNumber: null
additionalInfo:
quantity: 1
unitOfMeasure: ''
numberOfDeliveries: 0
schema:
$ref: '#/components/schemas/PostOrderPreviewResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Preview an order
tags:
- Orders
/v1/async/orders/preview:
post:
description: |
**Notes:**
- This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August 2020). If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.
- The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.
- You cannot preview enhanced discounts and usage charges.
In the case where a normal "Preview an order" operation call will time out, use this operation instead to preview an order asynchronously. A job will be previewing the order in the back end; the job ID will be returned for tracking the job status and result.
#### Billing preview behavior regarding draft invoices
By default, the billing preview behavior regarding draft invoices is as below:
* When you preview billing for your order and the order contains subscriptions only, the draft invoices are excluded.
* When you preview billing for your order and the order contains order line items only, the draft invoices are included.
* When you preview billing for an order that contains both subscriptions order line items, the draft invoices are included for both subscriptions and order line items.
However, if you want to always exclude the draft invoices in billing preview, submit a request at [Zuora Global Support](https://support.zuora.com).
#### Limits on Orders API
The limit of orders allowed on a subscription is 1000.
The limit of order line items allowed in an order is 100.
Zuora has the following limits on the Orders synchronous API to prevent performance degradation:
* Up to 50 subscriptions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
* Up to 50 order actions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
* Up to 50 order actions are allowed on a single subscription in a [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:
* [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
* [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
* [Retrieve the status and response of a job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse) for checking the status of the asynchronous API operations
Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:
* Up to 300 subscriptions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.
* Up to 300 order actions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.
* Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.
operationId: POST_PreviewOrderAsynchronously
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/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/POSTOrderPreviewAsyncRequestType'
required: true
responses:
'202':
content:
application/json:
examples:
response:
value:
jobId: 2c90a02d676688200167770ce20601b6
schema:
properties:
jobId:
description: The ID of an asynchronous job that will be returned for tracking the status and result of the job.
format: UUID
type: string
type: object
description: Accepted
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
Location:
description: URL for accessing the job result, in the format of `/async-jobs/{jobId}`. For example, `/async-jobs/2c90a02d676688200167770ce20601b6`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: Preview an order asynchronously
tags:
- Orders
/v1/orders:
get:
description: |
**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.
Retrieves information about all orders in your tenant. You can set the `status` query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value `all`, and orders of all statuses are returned.
By default, it returns the first page of the orders.
operationId: GET_AllOrders
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_REQUEST_page'
- $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
- description: |
The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate.
in: query
name: dateFilterOption
required: false
schema:
type: string
- description: |
The result will only contain the orders with the date of dateFilterOption later than or equal to this date.
in: query
name: startDate
required: false
schema:
format: date
type: string
- description: |
The result will only contains orders with the date of dateFilterOption earlier than or equal to this date.
in: query
name: endDate
required: false
schema:
format: date
type: string
- description: The status of orders.
in: query
name: status
required: false
schema:
enum:
- all
- cancelled
- completed
- draft
- executing
- failed
- pending
- scheduled
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
orders:
- createdBy: 2c989028622282520162235ab0f603ba
createdDate: '2018-03-14 15:12:58'
currency: USD
customFields:
order_cf_date__c: '2017-01-01'
description: This is a description for the Order.
existingAccountNumber: accountA_Num
orderDate: '2017-03-01'
orderLineItems:
- UOM: null
accountingCode: null
amount: 10000
amountPerUnit: 5000
amountWithoutTax: 10000
billTargetDate: null
billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa
billToSnapshotId: 4028fc8487c0a43c0187c12a91500060
customFields:
orderLineItemCF__c: olinumber-023
description: With Dual Stereo Microphones, HD 1080p, Black,USB connectivity for ease of use.
id: 4028fc827a0e48c1017a0e4dccc60002
invoiceGroupNumber: N-0001
invoiceOwnerAccountId: ff80808187ff38570187ff433cbd38ef
invoiceOwnerAccountName: AC_AC_16836148090011683614809001
invoiceOwnerAccountNumber: AN_1683614809001
itemName: webcam
itemNumber: '1'
itemState: Executing
itemType: Product
listPrice: 118
listPricePerUnit: 59
orderId: 4028fc827a0e48c1017a0e58b9330014
ownerAccountId: ff80808187ff38570187ff433f974203
ownerAccountName: AC_AC_16836148099861683614809986
ownerAccountNumber: AN_1683614809986
productCode: C9201
productRatePlanChargeId: null
purchaseOrderNumber: 960-000764
quantity: 2
soldTo: 4028fc828244a0ac018244dfc9a90bee
soldToSnapshotId: 4028fc828244a0ac018244dfc9b00bf0
transactionEndDate: '2021-02-01'
transactionStartDate: '2021-02-01'
orderNumber: O-00000002
status: Completed
subscriptions:
- baseVersion: 1
customFields:
sub_cf_picklist__c: null
newVersion: 2
orderActions:
- customFields:
oa_cf_text__c: null
sequence: 0
triggerDates:
- name: ContractEffective
triggerDate: '2017-03-01'
- name: ServiceActivation
triggerDate: '2017-03-01'
- name: CustomerAcceptance
triggerDate: '2017-03-01'
type: UpdateProduct
updateProduct:
chargeUpdates:
- billing:
billingPeriodAlignment: null
chargeNumber: C-00000001
customFields:
srpc_cf_picklist__c: null
description: null
effectiveDate:
specificTriggerDate: null
newRatePlanChargeId: 2c989028622282520162235adabc0651
pricing:
recurringVolume:
priceChangeOption: null
priceIncreasePercentage: null
quantity: 7
tiers: []
uniqueToken: null
customFields: {}
newRatePlanId: 2c989028622282520162235ada870649
ratePlanId: 2c989028622282520162235acd1b05d2
specificUpdateDate: null
uniqueToken: null
subscriptionNumber: A-S00000001
updatedBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:58'
- createdBy: 2c989028622282520162235ab0f603ba
createdDate: '2018-03-14 15:12:55'
currency: USD
existingAccountNumber: accountA_Num
orderDate: '2017-01-01'
orderNumber: O-00000001
status: Completed
subscriptions:
- baseVersion: null
customFields:
sub_cf_picklist__c: sub123
newVersion: 1
orderActions:
- createSubscription:
invoiceSeparately: null
invoiceGroupNumber: N-0001
notes: null
subscribeToRatePlans:
- chargeOverrides:
- billing:
billCycleDay: 1
billCycleType: null
billingPeriod: null
billingPeriodAlignment: null
billingTiming: null
specificBillingPeriod: null
weeklyBillCycleDay: null
chargeNumber: C-00000001
customFields:
srpc_cf_picklist__c: null
description: null
endDate:
endDateCondition: null
specificEndDate: null
upToPeriods: null
upToPeriodsType: null
pricing:
recurringVolume:
listPriceBase: Per_Billing_Period
priceChangeOption: null
priceIncreasePercentage: null
quantity: 12
tiers: []
productRateplanChargeId: 2c989028622282520162235aca7a05b9
startDate:
specificTriggerDate: null
uniqueToken: null
customFields: {}
newRatePlanId: 2c989028622282520162235acd1b05d2
productRatePlanId: 2c989028622282520162235ac91605b3
uniqueToken: null
subscriptionOwnerAccountNumber: accountA_Num
terms:
autoRenew: false
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 0
periodType: Month
customFields:
order_cf_date__c: '2017-01-01'
sequence: 0
triggerDates:
- name: ContractEffective
triggerDate: '2017-01-01'
- name: ServiceActivation
triggerDate: '2017-01-01'
- name: CustomerAcceptance
triggerDate: '2017-01-01'
type: CreateSubscription
subscriptionNumber: A-S00000001
success: true
updatedBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:55'
schema:
$ref: '#/components/schemas/GetAllOrdersResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List orders
tags:
- Orders
post:
description: |-
**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.
You can use this operation to create subscriptions and make changes to subscriptions by creating orders. You can also use this operation to create order line items by creating orders. The following tutorials demonstrate how to use this operation:
* [Create a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/A_Create_a_Subscription)
* [Add a Product to a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/A_Add_a_Product_to_a_Subscription)
* [Create a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/B_Create_a_Ramp_Deal)
* [Add a Product Mid-Interval Update on a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/E_Update_a_Product_in_a_Ramp_Deal)
* [Add a Product in a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/C_Add_a_Product_in_a_Ramp_Deal)
* [Change the Terms and Conditions of a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/D_Change_the_Terms_and_Conditions_of_a_Ramp_Deal_and_Update_the_Ramp)
* [Change the Owner of a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Change_the_Owner_of_a_Subscription)
* [Change the Terms and Conditions of a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Change_the_Terms_and_Conditions_of_a_Subscription)
* [Renew a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Renew_a_Subscription)
* [Renew a Subscription and Upgrade a Product](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Renew_a_Subscription_and_Upgrade_a_Product)
* [Replace a Product in a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Replace_a_Product_in_a_Subscription)
* [Update a Product in a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription)
* [Cancel a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/D_Cancel_a_Subscription)
* [Remove a Product from a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/D_Remove_a_Product_from_a_Subscription)
* [Create sales order line items](https://knowledgecenter.zuora.com/Zuora_Billing/Manage_non-subscription_transactions/Order_Line_Items/B_Manage_Order_Line_Items/AA_Create_a_sales_order_line_item_with_fulfillments)
* [Associate order line items with new subscriptions](https://knowledgecenter.zuora.com/Zuora_Billing/Manage_non-subscription_transactions/Order_Line_Items/B_Manage_Order_Line_Items/C_Associate_an_order_line_item_with_a_new_subscription)
* [Return order line items](https://knowledgecenter.zuora.com/Zuora_Billing/Manage_non-subscription_transactions/Order_Line_Items/B_Manage_Order_Line_Items/DA_Return_an_order_line_item_with_fulfillments)
You can also use this operation to create orders and save the orders as Scheduled Orders.
In addition, you can use this operation to place a standalone order to subscribe without pre-defining a product catalog in Zuora Billing. For more information, see Create a subscription using a standalone order.
**Note:** If you received a timeout error message when creating an order, the call is still running in the backend and the order will be created.
The limit of orders allowed on a subscription is 1000.
The limit of order line items allowed in an order is 100.
Zuora has the following limits on the Orders synchronous API to prevent performance degradation:
* Up to 50 subscriptions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
* Up to 50 order actions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
* Up to 50 order actions are allowed on a single subscription in a [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:
* [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
* [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
* [Retrieve the status and response of a job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse) for checking the status of the asynchronous API operations
Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:
* Up to 300 subscriptions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.
* Up to 300 order actions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.
* Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.
**Note:** When you are to suspend a subcription (via the `suspend` order action), if in the same "Create an order" call you are to perform other subsequent order actions on the supscription to suspend, you must first resume the subscription (via a `resume` order action).
**Note:** When using this operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. This means that the invoice will not be generated, the subscription will not be created, and the account will not be created.
**Note:** The characters `#`, `?`, and `/` are not allowed in the Orders operations.
operationId: POST_Order
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
Specify whether to return IDs associated with the numbers returned in the "Create an order" operation.
in: query
name: returnIds
required: false
schema:
default: false
type: boolean
- description: |
The minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTOrderRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
orderNumber: O-00000354
accountNumber: A00000097
status: Completed
subscriptions:
- subscriptionNumber: A-S00000129
subscriptionOwnerId: 2c92c0f87270a5970172747e289a5e66
subscriptionOwnerNumber: A00000001
status: Active
schema:
$ref: '#/components/schemas/PostOrderResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Create an order
tags:
- Orders
/v1/async/orders:
post:
description: |
**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.
In the case where a normal "Create an order" operation call will time out, use this operation instead to create an order asynchronously. A job will be creating the order in the back end; the job ID will be returned for tracking the job status and result.
Note that this operation doesn't support auto-refund and invoice write-off during subscription cancellation. Use the "Create an order" operation instead.
The limit of orders allowed on a subscription is 1000.
The limit of order line items allowed in an order is 100.
Zuora has the following limits on the Orders synchronous API to prevent performance degradation:
* Up to 50 subscriptions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
* Up to 50 order actions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
* Up to 50 order actions are allowed on a single subscription in a [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call.
If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations:
* [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
* [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
* [Retrieve the status and response of a job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse) for checking the status of the asynchronous API operations
Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation:
* Up to 300 subscriptions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.
* Up to 300 order actions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.
* Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call.
operationId: POST_CreateOrderAsynchronously
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
Specify whether to return IDs for the [Get job status and response](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse) operation. If you set this query parameter to `true`, the corresponding IDs, which are associated with the numbers returned in this operation, can be returned in the "Get job status and response" response body.
in: query
name: returnIds
required: false
schema:
default: false
type: boolean
- description: |
The minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTOrderAsyncRequestType'
required: true
responses:
'202':
content:
application/json:
examples:
response:
value:
jobId: 1bc24f315d7b48d3a20245bfe73bdceb
success: 'true'
schema:
properties:
jobId:
description: The ID of an asynchronous job that will be returned for tracking the status and result of the job.
format: UUID
type: string
success:
description: Indicates whether the operation call succeeded.
type: boolean
type: object
description: Accepted
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
Location:
description: URL for accessing the job result, in the format of `/async-jobs/{jobId}`. For example, `/async-jobs/1bc24f315d7b48d3a20245bfe73bdceb`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: Create an order asynchronously
tags:
- Orders
/v1/orders/{orderNumber}:
delete:
description: |
**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.
Deletes a specified order.
* All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version.
* All the order line items created in this order are deleted.
You are not allowed to delete an order in the following situations:
- The charges that are affected by this order are invoiced.
- The order is reverted and in the `Reverted` status.
operationId: DELETE_Order
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The number of the order to be deleted.
in: path
name: orderNumber
required: true
schema:
format: string
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Delete an order
tags:
- Orders
get:
description: |
**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.
Retrieves the detailed information about a specified order.
operationId: GET_Order
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The order number to be retrieved.
in: path
name: orderNumber
required: true
schema:
format: string
type: string
- description: Retrieves the invoice owner account details and subscription owner account details in the Order.
in: query
name: getAccountDetails
schema:
type: boolean
responses:
'200':
content:
application/json:
examples:
response:
value:
order:
createdBy: 402881e522cf4f9b0122cf5d82860002
createdDate: '2018-12-13 17:21:43'
currency: USD
customFields: {}
description: This is a description for the Order.
existingAccountNumber: A00000101
existingAccountDetails:
basicInfo:
accountNumber: A00000001
batch: Batch1
communicationProfileId: 303d186840e611df817c002185d714e1
crmId: ''
id: 402892c74c9193cd014c91d35b0a0132
invoiceTemplateId: null
name: Test
notes: ''
partnerAccount: false
profileNumber: CP-00000012
salesRep: ''
sequenceSetId: null
status: Active
summaryStatementTemplateId: null
purchaseOrderNumber: ''
billToContact:
address1: ''
address2: ''
city: ''
country: null
county: null
fax: ''
firstName: Test
homePhone: ''
id: 2c9081a03c6d7b51013c6d7e46c80a17
lastName: Test
mobilePhone: ''
nickname: ''
otherPhone: ''
otherPhoneType: null
personalEmail: ''
state: ''
taxRegion: null
workEmail: contact@example.com
workPhone: ''
zipCode: ''
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
orderDate: '2018-10-01'
orderLineItems:
- UOM: null
accountingCode: null
amount: 10000
amountPerUnit: 5000
amountWithoutTax: 10000
billTargetDate: null
billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa
billToSnapshotId: 4028fc8487c0a43c0187c12a91500060
customFields:
orderLineItemCF__c: olinumber-023
description: With Dual Stereo Microphones, HD 1080p, Black,USB connectivity for ease of use.
id: 4028fc827a0e48c1017a0e4dccc60002
invoiceGroupNumber: N-0001
invoiceOwnerAccountId: ff80808187ff38570187ff433cbd38ef
invoiceOwnerAccountName: AC_AC_16836148090011683614809001
invoiceOwnerAccountNumber: AN_1683614809001
itemName: webcam
itemNumber: '1'
itemState: Executing
itemType: Product
listPrice: 118
listPricePerUnit: 59
orderId: 4028fc827a0e48c1017a0e58b9330014
ownerAccountId: ff80808187ff38570187ff433f974203
ownerAccountName: AC_AC_16836148099861683614809986
ownerAccountNumber: AN_1683614809986
productCode: C9201
productRatePlanChargeId: null
purchaseOrderNumber: 960-000764
quantity: 2
soldTo: 4028fc828244a0ac018244dfc9a90bee
soldToSnapshotId: 4028fc828244a0ac018244dfc9b00bf0
transactionEndDate: '2021-02-01'
transactionStartDate: '2021-02-01'
orderNumber: O-00000282
status: Completed
subscriptions:
- baseVersion: 1
customFields: {}
externallyManagedBy: null
newVersion: 2
orderActions:
- customFields: {}
sequence: 0
triggerDates:
- name: ContractEffective
triggerDate: '2018-12-01'
- name: ServiceActivation
triggerDate: '2018-12-01'
- name: CustomerAcceptance
triggerDate: '2018-12-01'
type: UpdateProduct
updateProduct:
chargeUpdates:
- billing:
billingPeriodAlignment: null
chargeNumber: C-00000210
customFields: {}
description: null
effectiveDate:
specificTriggerDate: null
newRatePlanChargeId: 2c98919c67a5ae9d0167a6df304b0372
pricing:
recurringPerUnit:
listPrice: 20
priceChangeOption: null
priceIncreasePercentage: null
quantity: null
uniqueToken: null
customFields: {}
newRatePlanId: 2c98919c67a5ae9d0167a6df3011036e
ratePlanId: 2c98919c67a5ae9d0167a68f8eb20262
specificUpdateDate: null
uniqueToken: null
subscriptionNumber: A-S00000100
subscriptionOwnerAccountNumber: A00000001
subscriptionOwnerAccountDetails:
accountNumber: A00000001
batch: Batch1
communicationProfileId: 303d186840e611df817c002185d714e1
crmId: ''
id: 402892c74c9193cd014c91d35b0a0132
invoiceTemplateId: null
name: Test
notes: ''
partnerAccount: false
profileNumber: CP-00000012
salesRep: ''
sequenceSetId: null
status: Active
summaryStatementTemplateId: null
purchaseOrderNumber: ''
billToContact:
address1: ''
address2: ''
city: ''
country: null
county: null
fax: ''
firstName: Test
homePhone: ''
id: 2c9081a03c6d7b51013c6d7e46c80a17
lastName: Test
mobilePhone: ''
nickname: ''
otherPhone: ''
otherPhoneType: null
personalEmail: ''
state: ''
taxRegion: null
workEmail: contact@example.com
workPhone: ''
zipCode: ''
- baseVersion: 1
customFields: {}
externallyManagedBy: null
newVersion: 2
orderActions:
- customFields: {}
sequence: 0
suspend:
suspendDate: '2018-12-13'
suspendPeriods: 1
suspendPeriodsType: Week
suspendPolicy: Today
suspendSpecificDate: null
triggerDates:
- name: ContractEffective
triggerDate: '2018-12-01'
- name: ServiceActivation
triggerDate: '2018-12-01'
- name: CustomerAcceptance
triggerDate: '2018-12-01'
type: Suspend
subscriptionNumber: A-S00000101
subscriptionOwnerAccountNumber: A00000001
subscriptionOwnerAccountDetails:
accountNumber: A00000001
batch: Batch1
communicationProfileId: 303d186840e611df817c002185d714e1
crmId: ''
id: 402892c74c9193cd014c91d35b0a0132
invoiceTemplateId: null
name: Test
notes: ''
partnerAccount: false
profileNumber: CP-00000012
salesRep: ''
sequenceSetId: null
status: Active
summaryStatementTemplateId: null
purchaseOrderNumber: ''
soldToContact:
address1: ''
address2: ''
city: ''
country: null
county: null
fax: ''
firstName: Test
homePhone: ''
id: 2c9081a03c6d7b51013c6d7e46c80a17
lastName: Test
mobilePhone: ''
nickname: ''
otherPhone: ''
otherPhoneType: null
personalEmail: ''
state: ''
taxRegion: null
workEmail: contact@example.com
workPhone: ''
zipCode: ''
- baseVersion: 2
customFields: {}
externallyManagedBy: null
newVersion: 3
orderActions:
- customFields: {}
resume:
extendsTerm: true
resumeDate: '2018-12-23'
resumePeriods: 10
resumePeriodsType: Day
resumePolicy: FixedPeriodsFromSuspendDate
resumeSpecificDate: null
sequence: 0
triggerDates:
- name: ContractEffective
triggerDate: '2018-12-12'
- name: ServiceActivation
triggerDate: '2018-12-12'
- name: CustomerAcceptance
triggerDate: '2018-12-12'
type: Resume
- customFields: {}
sequence: 1
termsAndConditions:
autoRenew: null
invoiceGroupNumber: N-0001
clearingExistingInvoiceGroupNumber: false
initialTerm:
period: 375
periodType: Day
startDate: null
termType: null
renewalSetting: null
renewalTerms:
- period: null
periodType: null
triggerDates:
- name: ContractEffective
triggerDate: '2018-12-12'
- name: ServiceActivation
triggerDate: '2018-12-12'
- name: CustomerAcceptance
triggerDate: '2018-12-12'
type: TermsAndConditions
subscriptionNumber: A-S00000102
subscriptionOwnerAccountNumber: A00000001
updatedBy: 402881e522cf4f9b0122cf5d82860002
updatedDate: '2018-12-13 17:21:45'
success: true
schema:
$ref: '#/components/schemas/GetOrderResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve an order
tags:
- Orders
put:
description: |
**Notes:**
- This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.
- Update an order is only valid for draft or scheduled orders.
- This operation doesn't support auto-refund and invoice write-off during subscription cancellation. Use the "Create an order" operation instead.
- You must provide full payload when using the "Update an order" operation. That is, if you want to edit one order action, you need to provide all other order actions in the payload. Otherwise, the other order actions will be removed.
operationId: PUT_Order
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Order number of a order in which you are to update.
in: path
name: orderNumber
required: true
schema:
format: string
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTOrderRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
orderNumber: O-00000758
accountNumber: A00000097
status: Draft
schema:
$ref: '#/components/schemas/PutOrderResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update an order
tags:
- Orders
/v1/async/orders/{orderNumber}:
delete:
description: |
**Note:** This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable
Orders Harmonization to access the Orders feature. With Orders, you can access both existing\
functions for subscription and billing management and the new features on Zuora Billing.
**Note:** The Order Line Items
feature is now generally available to all Zuora customers. You need to enable
the Orders
feature to access the Order Line Items
feature. As of Zuora Billing Release 313 (November 2021), new customers who\
onboard on Orders
will have the Order Line Items feature enabled by default.
Deletes a specified order.
All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version.
All the order line items created in this order are deleted.
You are not allowed to delete an order in the following situations:
- The charges that are affected by this order are invoiced.
- The order is reverted and in the `Reverted` status.
operationId: deleteOrderAsynchronously
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- description: The number of the order to be deleted.
in: path
name: orderNumber
required: true
schema:
format: string
type: string
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
responses:
'200':
content:
application/json:
example:
jobId: 2c90a02d676688200167770ce20601b6
success: true
schema:
$ref: '#/components/schemas/DeleteOrderAsyncResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. '
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. '
schema:
maxLength: 64
type: string
4XX:
content:
application/json:
example:
processId: 30591668A6FFCE5C
reasons:
- code: '51001122'
message: '''billToContact'' may not be null'
- code: '51000030'
message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Invalid input
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: Delete an order asynchronously
tags:
- Orders
/v1/async-jobs/{jobId}:
get:
description: |
**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.
Get the status and response of an asynchronous job. Currently, an asynchronous job created by "Create an order asynchronously" or "Preview an order asynchronously" is supported.
operationId: GET_JobStatusAndResponse
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- description: UUID of the asynchronous job created by an asynchronous API operation.
in: path
name: jobId
required: true
schema:
format: UUID
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
errors: null
result:
jobType: AsyncCreateOrder
accountNumber: A00000001
invoiceNumbers:
- INV00000001
orderLineItems:
- id: bd78c0522adf42c2aa0fccacc997fa20
itemNumber: '116'
orderNumber: OM-00002
paidAmount: '300'
paymentNumber: P-00000002
status: Pending
subscriptions:
- status: Pending Activation
subscriptionNumber: SM-00001
- status: Pending Acceptance
subscriptionNumber: SM-00002
- status: Active
subscriptionNumber: SM-00003
- status: Pending Acceptance
subscriptionNumber: SM-00004
success: true
status: Completed
success: true
schema:
$ref: '#/components/schemas/GetAsyncOrderJobResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve the status and response of a job
tags:
- Orders
/v1/orders/subscriptionOwner/{accountNumber}:
get:
description: |
**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.
Retrieves the detailed information about all orders for a specified subscription owner. Any orders containing the changes on the subscriptions owned by this account are returned.
**Note**: You cannot retrieve detailed information about draft orders or scheduled orders through this operation.
operationId: GET_OrdersBySubscriptionOwner
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The subscription owner account number.
in: path
name: accountNumber
required: true
schema:
format: string
type: string
- $ref: '#/components/parameters/GLOBAL_REQUEST_page'
- $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
- description: |
The date type to filter on.
This field value can be 'orderDate' or 'updatedDate'. Default is orderDate.
in: query
name: dateFilterOption
required: false
schema:
type: string
- description: |
The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date.
in: query
name: startDate
required: false
schema:
format: date
type: string
- description: |
The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date.
in: query
name: endDate
required: false
schema:
format: date
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
orders:
- createdBy: 2c989028622282520162235ab0f603ba
createdDate: '2018-03-14 15:12:58'
currency: USD
customFields:
order_cf_date__c: '2017-01-01'
description: This is a description for the Order.
existingAccountNumber: accountA_Num
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
orderDate: '2017-03-01'
orderNumber: O-00000002
status: Completed
subscriptions:
- baseVersion: 1
customFields:
sub_cf_picklist__c: null
newVersion: 2
orderActions:
- customFields:
oa_cf_text__c: null
sequence: 0
triggerDates:
- name: ContractEffective
triggerDate: '2017-03-01'
- name: ServiceActivation
triggerDate: '2017-03-01'
- name: CustomerAcceptance
triggerDate: '2017-03-01'
type: UpdateProduct
updateProduct:
chargeUpdates:
- billing:
billingPeriodAlignment: null
chargeNumber: C-00000001
customFields:
srpc_cf_picklist__c: null
description: null
effectiveDate:
specificTriggerDate: null
newRatePlanChargeId: 2c989028622282520162235adabc0651
pricing:
recurringVolume:
priceChangeOption: null
priceIncreasePercentage: null
quantity: 7
tiers: []
uniqueToken: null
customFields: {}
newRatePlanId: 2c989028622282520162235ada870649
ratePlanId: 2c989028622282520162235acd1b05d2
specificUpdateDate: null
uniqueToken: null
subscriptionNumber: A-S00000001
updatedBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:58'
- createdBy: 2c989028622282520162235ab0f603ba
createdDate: '2018-03-14 15:12:55'
currency: USD
customFields:
order_cf_date__c: '2017-01-01'
existingAccountNumber: accountA_Num
orderDate: '2017-01-01'
orderNumber: O-00000001
status: Completed
subscriptions:
- baseVersion: null
customFields:
sub_cf_picklist__c: sub123
newVersion: 1
orderActions:
- createSubscription:
invoiceSeparately: null
notes: null
subscribeToRatePlans:
- chargeOverrides:
- billing:
billCycleDay: 1
billCycleType: null
billingPeriod: null
billingPeriodAlignment: null
billingTiming: null
specificBillingPeriod: null
weeklyBillCycleDay: null
chargeNumber: C-00000001
customFields:
srpc_cf_picklist__c: null
description: null
endDate:
endDateCondition: null
specificEndDate: null
upToPeriods: null
upToPeriodsType: null
pricing:
recurringVolume:
listPriceBase: Per_Billing_Period
priceChangeOption: null
priceIncreasePercentage: null
quantity: 12
tiers: []
productRateplanChargeId: 2c989028622282520162235aca7a05b9
startDate:
specificTriggerDate: null
uniqueToken: null
customFields: {}
newRatePlanId: 2c989028622282520162235acd1b05d2
productRatePlanId: 2c989028622282520162235ac91605b3
uniqueToken: null
subscriptionOwnerAccountNumber: accountA_Num
terms:
autoRenew: false
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 0
periodType: Month
customFields:
oa_cf_text__c: oa cf test
sequence: 0
triggerDates:
- name: ContractEffective
triggerDate: '2017-01-01'
- name: ServiceActivation
triggerDate: '2017-01-01'
- name: CustomerAcceptance
triggerDate: '2017-01-01'
type: CreateSubscription
subscriptionNumber: A-S00000001
updatedBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:55'
success: true
schema:
$ref: '#/components/schemas/GetOrdersResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List orders of a subscription owner
tags:
- Orders
/v1/orders/subscription/{subscriptionNumber}:
get:
description: |
**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.
Retrieves the detailed information about all orders for a specified subscription. You can set the `status` query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value `all`, and orders of all statuses are returned.
operationId: GET_OrdersBySubscriptionNumber
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The subscription number.
in: path
name: subscriptionNumber
required: true
schema:
type: string
- $ref: '#/components/parameters/GLOBAL_REQUEST_page'
- $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
- description: |
The date type to filter on. This field value can be 'orderDate' or 'updatedDate'. Default is orderDate.
in: query
name: dateFilterOption
required: false
schema:
type: string
- description: |
The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date.
in: query
name: startDate
required: false
schema:
format: date
type: string
- description: |
The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date.
in: query
name: endDate
required: false
schema:
format: date
type: string
- description: The status of orders.
in: query
name: status
required: false
schema:
enum:
- all
- cancelled
- completed
- draft
- executing
- failed
- pending
- scheduled
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
orders:
- createdBy: 2c989028622282520162235ab0f603ba
createdDate: '2018-03-14 15:12:58'
currency: USD
customFields:
order_cf_date__c: '2017-01-01'
description: This is a description for the Order.
existingAccountNumber: accountA_Num
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
orderDate: '2017-03-01'
orderNumber: O-00000002
status: Completed
subscriptions:
- baseVersion: 1
customFields:
sub_cf_picklist__c: null
newVersion: 2
orderActions:
- customFields:
oa_cf_text__c: null
sequence: 0
triggerDates:
- name: ContractEffective
triggerDate: '2017-03-01'
- name: ServiceActivation
triggerDate: '2017-03-01'
- name: CustomerAcceptance
triggerDate: '2017-03-01'
type: UpdateProduct
updateProduct:
chargeUpdates:
- billing:
billingPeriodAlignment: null
chargeNumber: C-00000001
customFields:
srpc_cf_picklist__c: null
description: null
effectiveDate:
specificTriggerDate: null
newRatePlanChargeId: 2c989028622282520162235adabc0651
pricing:
recurringVolume:
priceChangeOption: null
priceIncreasePercentage: null
quantity: 7
tiers: []
uniqueToken: null
customFields: {}
newRatePlanId: 2c989028622282520162235ada870649
ratePlanId: 2c989028622282520162235acd1b05d2
specificUpdateDate: null
uniqueToken: null
subscriptionNumber: A-S00000001
updatedBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:58'
- createdBy: 2c989028622282520162235ab0f603ba
createdDate: '2018-03-14 15:12:55'
currency: USD
customFields:
order_cf_date__c: '2017-01-01'
existingAccountNumber: accountA_Num
orderDate: '2017-01-01'
orderNumber: O-00000001
status: Completed
subscriptions:
- baseVersion: null
customFields:
sub_cf_picklist__c: sub123
newVersion: 1
orderActions:
- createSubscription:
invoiceSeparately: null
notes: null
subscribeToRatePlans:
- chargeOverrides:
- billing:
billCycleDay: 1
billCycleType: null
billingPeriod: null
billingPeriodAlignment: null
billingTiming: null
specificBillingPeriod: null
weeklyBillCycleDay: null
chargeNumber: C-00000001
customFields:
srpc_cf_picklist__c: null
description: null
endDate:
endDateCondition: null
specificEndDate: null
upToPeriods: null
upToPeriodsType: null
pricing:
recurringVolume:
listPriceBase: Per_Billing_Period
priceChangeOption: null
priceIncreasePercentage: null
quantity: 12
tiers: []
productRateplanChargeId: 2c989028622282520162235aca7a05b9
startDate:
specificTriggerDate: null
uniqueToken: null
customFields: {}
newRatePlanId: 2c989028622282520162235acd1b05d2
productRatePlanId: 2c989028622282520162235ac91605b3
uniqueToken: null
subscriptionOwnerAccountNumber: accountA_Num
terms:
autoRenew: false
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 0
periodType: Month
customFields:
oa_cf_text__c: oa cf test
sequence: 0
triggerDates:
- name: ContractEffective
triggerDate: '2017-01-01'
- name: ServiceActivation
triggerDate: '2017-01-01'
- name: CustomerAcceptance
triggerDate: '2017-01-01'
type: CreateSubscription
subscriptionNumber: A-S00000001
updatedBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:55'
success: true
schema:
$ref: '#/components/schemas/GetOrdersResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List orders by subscription number
tags:
- Orders
/v1/orders/invoiceOwner/{accountNumber}:
get:
description: |
**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.
Retrieves the detailed information about all orders for a specified invoice owner. You can set the `status` query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value `all`, and orders of all statuses are returned.
operationId: GET_OrdersByInvoiceOwner
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The invoice owner account number.
in: path
name: accountNumber
required: true
schema:
format: string
type: string
- $ref: '#/components/parameters/GLOBAL_REQUEST_page'
- $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
- description: |
The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate.
in: query
name: dateFilterOption
required: false
schema:
type: string
- description: |
The result will only contain the orders with the date of dateFilterOption later than or equal to this date.
in: query
name: startDate
required: false
schema:
format: date
type: string
- description: |
The result will only contain the orders with the date of dateFilterOption earlier than or equal to this date.
in: query
name: endDate
required: false
schema:
format: date
type: string
- description: The status of orders.
in: query
name: status
required: false
schema:
enum:
- all
- cancelled
- completed
- draft
- executing
- failed
- pending
- scheduled
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
orders:
- createdBy: 2c989028622282520162235ab0f603ba
createdDate: '2018-03-14 15:12:58'
currency: USD
customFields:
order_cf_date__c: '2017-01-01'
description: This is a description for the Order.
existingAccountNumber: accountA_Num
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
orderDate: '2017-03-01'
orderNumber: O-00000002
status: Completed
subscriptions:
- baseVersion: 1
customFields:
sub_cf_picklist__c: null
newVersion: 2
orderActions:
- customFields:
oa_cf_text__c: null
sequence: 0
triggerDates:
- name: ContractEffective
triggerDate: '2017-03-01'
- name: ServiceActivation
triggerDate: '2017-03-01'
- name: CustomerAcceptance
triggerDate: '2017-03-01'
type: UpdateProduct
updateProduct:
chargeUpdates:
- billing:
billingPeriodAlignment: null
chargeNumber: C-00000001
customFields:
srpc_cf_picklist__c: null
description: null
effectiveDate:
specificTriggerDate: null
newRatePlanChargeId: 2c989028622282520162235adabc0651
pricing:
recurringVolume:
priceChangeOption: null
priceIncreasePercentage: null
quantity: 7
tiers: []
uniqueToken: null
customFields: {}
newRatePlanId: 2c989028622282520162235ada870649
ratePlanId: 2c989028622282520162235acd1b05d2
specificUpdateDate: null
uniqueToken: null
subscriptionNumber: A-S00000001
updatedBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:58'
- createdBy: 2c989028622282520162235ab0f603ba
createdDate: '2018-03-14 15:12:55'
currency: USD
customFields:
order_cf_date__c: '2017-01-01'
existingAccountNumber: accountA_Num
orderDate: '2017-01-01'
orderNumber: O-00000001
status: Completed
subscriptions:
- baseVersion: null
customFields:
sub_cf_picklist__c: sub123
newVersion: 1
orderActions:
- createSubscription:
invoiceSeparately: null
notes: null
subscribeToRatePlans:
- chargeOverrides:
- billing:
billCycleDay: 1
billCycleType: null
billingPeriod: null
billingPeriodAlignment: null
billingTiming: null
specificBillingPeriod: null
weeklyBillCycleDay: null
chargeNumber: C-00000001
customFields:
srpc_cf_picklist__c: null
description: null
endDate:
endDateCondition: null
specificEndDate: null
upToPeriods: null
upToPeriodsType: null
pricing:
recurringVolume:
listPriceBase: Per_Billing_Period
priceChangeOption: null
priceIncreasePercentage: null
quantity: 12
tiers: []
productRateplanChargeId: 2c989028622282520162235aca7a05b9
startDate:
specificTriggerDate: null
uniqueToken: null
customFields: {}
newRatePlanId: 2c989028622282520162235acd1b05d2
productRatePlanId: 2c989028622282520162235ac91605b3
uniqueToken: null
subscriptionOwnerAccountNumber: accountA_Num
terms:
autoRenew: false
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 0
periodType: Month
customFields:
oa_cf_text__c: oa cf test
sequence: 0
triggerDates:
- name: ContractEffective
triggerDate: '2017-01-01'
- name: ServiceActivation
triggerDate: '2017-01-01'
- name: CustomerAcceptance
triggerDate: '2017-01-01'
type: CreateSubscription
subscriptionNumber: A-S00000001
updatedBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:55'
success: true
schema:
$ref: '#/components/schemas/GetOrdersResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List orders of an invoice owner
tags:
- Orders
/v1/orders/{orderNumber}/customFields:
put:
description: |
**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.
**Note:** To update the custom fields of an order line item, you must use the "Update an order line item" or "Update order line items" operation.
Updates the custom fields of a specified order.
operationId: PUT_UpdateOrderCustomFields
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The order number.
in: path
name: orderNumber
required: true
schema:
format: string
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTOrderPatchRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update order custom fields
tags:
- Orders
/v1/subscriptions/{subscriptionNumber}/customFields:
put:
description: |
**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.
Updates the custom fields of a specified subscription.
operationId: PUT_UpdateSubscriptionCustomFields
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The subscription number to be updated.
in: path
name: subscriptionNumber
required: true
schema:
format: string
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTSubscriptionPatchRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update subscription custom fields
tags:
- Orders
/v1/orders/{orderNumber}/triggerDates:
put:
description: |
**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.
Updates the triggering dates for either of the following order actions:
* CreateSubscription
* AddProduct
* UpdateProduct
* RemoveProduct
* RenewSubscription
* TermsAndConditions
operationId: PUT_OrderTriggerDates
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Order number of a pending order in which you are to update an order action's triggering dates.
in: path
name: orderNumber
required: true
schema:
format: string
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTOrderActionTriggerDatesRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
orderNumber: O-00000408
status: Completed
accountNumber: A00000097
subscriptions:
- subscriptionNumber: A-S00000143
status: Active
schema:
$ref: '#/components/schemas/PUTOrderTriggerDatesResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update order action trigger dates
tags:
- Orders
/v1/orders/{orderNumber}/activate:
put:
description: |
**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.
Activate order is only available for draft orders.
operationId: PUT_OrderActivate
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Order number of a order in which you are to activate.
in: path
name: orderNumber
required: true
schema:
format: string
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
accountNumber: A00000001
invoiceNumbers:
- INV00000001
orderLineItems:
- id: bd78c0522adf42c2aa0fccacc997fa20
itemNumber: '116'
orderNumber: OM-00002
paidAmount: 300
paymentNumber: P-00000002
status: Pending
subscriptions:
- status: Pending Activation
subscriptionNumber: SM-00001
- status: Pending Acceptance
subscriptionNumber: SM-00002
- status: Active
subscriptionNumber: SM-00003
- status: Pending Acceptance
subscriptionNumber: SM-00004
- status: Suspended
subscriptionNumber: SM-00005
- status: Active
subscriptionNumber: SM-00006
success: true
schema:
$ref: '#/components/schemas/PostOrderResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Activate an order
tags:
- Orders
/v1/orders/{orderNumber}/cancel:
put:
description: |-
**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.
**Note:** Cancellation is only valid for draft or scheduled orders. If the order is not in draft or scheduled status, the API returns an error.
operationId: PUT_OrderCancel
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The order number of the draft order you wish to cancel.
in: path
name: orderNumber
required: true
schema:
format: string
type: string
requestBody:
content:
application/json:
schema:
properties:
cancelReason:
description: The reason for cancelling the order.
example: Customer cancelled the order.
type: string
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
CancelReason: Customer cancelled the order.
accountNumber: A00000001
orderNumber: OM-00002
status: Cancelled
success: true
schema:
$ref: '#/components/schemas/PutOrderCancelResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Cancel an order
tags:
- Orders
/v1/orders/{orderNumber}/revert:
post:
description: |
Reverts an order though this operation.
**Note**: This operation is only available if you have the following features turned on:
- Orders
- Single Version Subscription
For information on what orders can be reverted, see Revert orders.
operationId: revertOrder
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The order number of the order you wish to revert.
in: path
name: orderNumber
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RevertOrderRequest'
required: true
responses:
'200':
content:
application/json:
example:
accountNumber: A00000001
orderNumber: O-00000020
status: Completed
success: true
subscriptionNumbers:
- A-S00000001
schema:
$ref: '#/components/schemas/RevertOrderResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. '
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. '
schema:
maxLength: 64
type: string
4XX:
content:
application/json:
example:
processId: processId
reasons:
- code: '51001122'
message: '''billToContact'' may not be null'
- code: '51000030'
message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Invalid input
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Revert an order
tags:
- Orders
/v1/orders/subscription/{subscription-key}/pending:
get:
description: |
**Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.
Retrieves the detailed information about all pending orders for a specified subscription.
operationId: GET_PendingOrdersBySubscriptionNumber
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
Subscription number. For example, A-S00000135.
in: path
name: subscription-key
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
orders:
- createdBy: 2c989028622282520162235ab0f603ba
createdDate: '2018-03-14 15:12:55'
currency: USD
existingAccountNumber: accountA_Num
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
orderDate: '2017-01-01'
orderNumber: O-00000001
status: Pending
subscriptions:
- baseVersion: null
customFields:
sub_cf_picklist__c: sub123
newVersion: 1
orderActions:
- createSubscription:
subscribeToRatePlans:
- chargeOverrides:
- chargeNumber: C-00000001
pricing:
recurringVolume:
listPriceBase: Per_Billing_Period
quantity: 12
tiers: []
productRateplanChargeId: 2c989028622282520162235aca7a05b9
customFields: {}
newRatePlanId: 2c989028622282520162235acd1b05d2
productRatePlanId: 2c989028622282520162235ac91605b3
subscriptionOwnerAccountNumber: accountA_Num
terms:
autoRenew: false
initialTerm:
period: 12
periodType: Month
startDate: '2017-01-01'
termType: TERMED
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerms:
- period: 0
periodType: Month
customFields:
order_cf_date__c: '2017-01-01'
sequence: 0
triggerDates:
- name: ContractEffective
triggerDate: '2017-01-01'
- name: ServiceActivation
triggerDate: '2017-01-01'
type: CreateSubscription
subscriptionNumber: A-S00000001
success: true
updatedBy: 2c989028622282520162235ab0f603ba
updatedDate: '2018-03-14 15:12:55'
schema:
$ref: '#/components/schemas/GetAllOrdersResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List pending orders by subscription number
tags:
- Orders
/v1/orderActions/{id}:
put:
description: Updates the change reason and custom fields for an order action.
operationId: PUT_OrderActions
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The id of the Order Action to update.
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTOrderActionsRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update an order action
tags:
- Order Actions
/v1/order-line-items/{itemId}:
get:
description: |
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. If you are a new customer who onboard on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/). If you are an existing [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) customer and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/).
Retrieves the detailed information about a specified order line item. The following tutorial demonstrates how to use this operation:
* [View details of an order line item](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/GJ_View_details_of_an_order_line_item)
operationId: GET_OrderLineItem
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The id of the Order Line Item to retrieve.
in: path
name: itemId
required: true
schema:
format: UUID
type: string
- description: |
Return the related fulfillments or not.
in: query
name: fulfillment
required: false
schema:
default: false
type: boolean
responses:
'200':
content:
application/json:
examples:
response:
value:
orderLineItem:
UOM: null
accountingCode: null
amount: 10000
amountPerUnit: 5000
amountWithoutTax: 10000
billTargetDate: null
billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa
billToSnapshotId: 4028fc8487c0a43c0187c12a91500060
customFields:
externalNumber5__c: olinumber-023
description: With Dual Stereo Microphones, HD 1080p, Black,USB connectivity for ease of use.
id: 4028fc827a0e48c1017a0e4dccc60002
invoiceGroupNumber: N-0001
invoiceOwnerAccountId: ff80808187ff38570187ff433cbd38ef
invoiceOwnerAccountName: AC_AC_16836148090011683614809001
invoiceOwnerAccountNumber: AN_1683614809001
itemName: webcam
itemNumber: '1'
itemState: Executing
itemType: Product
listPrice: 118
listPricePerUnit: 59
orderId: 4028fc827a0e48c1017a0e58b9330014
ownerAccountId: ff80808187ff38570187ff433f974203
ownerAccountName: AC_AC_16836148099861683614809986
ownerAccountNumber: AN_1683614809986
productCode: C9201
productRatePlanChargeId: null
purchaseOrderNumber: 960-000764
quantity: 2
relatedSubscriptionNumber: Warranty-00002
soldTo: 4028fc828244a0ac018244dfc9a90bee
soldToSnapshotId: 4028fc828244a0ac018244dfc9b00bf0
transactionDate: '2021-02-01'
success: true
schema:
$ref: '#/components/schemas/GetOrderLineItemResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve an order line item
tags:
- Order Line Items
put:
description: |
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. If you are a new customer who onboard on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/). If you are an existing [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) customer and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/).
Updates a specified order line item. The following tutorials demonstrate how to use this operation:
* [Update an order line item](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/GH_Update_an_order_line_item)
* [Cancel an order line item](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/GZ_Cancel_an_order_line_item)
operationId: PUT_OrderLineItem
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The id of the Order Line Item to update.
in: path
name: itemId
required: true
schema:
format: UUID
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTOrderLineItemRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/PutOrderLineItemResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update an order line item
tags:
- Order Line Items
/v1/order-line-items/bulk:
post:
description: |
**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. If you are a new customer who onboard on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/). If you are an existing [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) customer and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/).
Bulk-updates multiple order line items. You can also choose to generate an invoice for these updated order line items.
The maximum number of order line items allowable to update in a call is 100.
operationId: Post_OrderLineItems
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/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/PostOrderLineItemsRequestType'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetOrderLineItemResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update order line items
tags:
- Order Line Items
/v1/fulfillments:
post:
description: |
Creates one or multiple Fulfillment objects. You can also generate invoices or memos for these Fulfillment objects in this API call. The following tutorials demonstrate how to use this operation:
* [Create a sales order line item with fulfillments](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AD_Create_a_sales_order_line_item_with_fulfillments)
* [Create a return order line item with fulfillments](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/Create_a_return_order_line_item_with_fulfillments)
operationId: Create_Fulfillment
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/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/PostFulfillmentsRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
creditMemoNumbers: null
fulfillments:
- fulfillmentNumber: F-00000001
id: 4028828c82819b740182821bb3b415c6
- fulfillmentNumber: F-00000002
id: 4028828c82819b740182821bb3bc15c7
invoiceNumbers:
- INV00000001
paidAmount: 100
paymentNumber: P-00000001
success: true
schema:
$ref: '#/components/schemas/PostFulfillmentsResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Create fulfillments
tags:
- Fulfillments
/v1/fulfillments/{key}:
delete:
description: |
Deletes a specified fulfillment. A fulfillment can only be deleted when it is in the `Executing` state.
operationId: Delete_Fulfillment
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The id or fulfillment number of the Fulfillment to delete.
in: path
name: key
required: true
schema:
format: UUID
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Delete a fulfillment
tags:
- Fulfillments
get:
description: |
Retrieves the detailed information about a specified fulfillment. The following tutorial demonstrates how to use this operation:
* [View details of a fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/H_View_details_of_a_fulfillment)
operationId: GET_Fulfillment
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The id or fulfillment number of the Fulfillment to retrieve.
in: path
name: key
required: true
schema:
format: UUID
type: string
- description: Return the related fulfillment items or not.
in: query
name: fulfillment-items
required: false
schema:
default: false
type: boolean
responses:
'200':
content:
application/json:
examples:
response:
value:
fulfillment:
billTargetDate: '2022-01-01'
carrier: carrier
customFields:
priority__c: Hight
description: description
externalId: 9dc1a064-b5d1-4d7b-bd0b-ca26a1be8e01
fulfillmentDate: '2022-01-01'
fulfillmentItems:
- customFields:
category__c: Old
description: description
fulfillmentId: 4028828c82819b74018281a69d3f0d93
id: 4028828c82819b74018281a69d680d98
itemIdentifier: 87309cf0-10c7-4130-8da2-439c96daa1ff
fulfillmentLocation: location
fulfillmentNumber: F-00000001
fulfillmentSystem: fulfillment system
fulfillmentType: Delivery
id: 4028828c82819b74018281a69d3f0d93
orderLineItemId: 4028828c82819b74018281a69adf0d4e
quantity: 1
state: SentToBilling
trackingNumber: T-00091912
success: true
schema:
$ref: '#/components/schemas/GetFulfillmentResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a fulfillment
tags:
- Fulfillments
put:
description: |
Updates a specified fulfillment. The `state` field of a fulfillment can only be updated when it is in a different state, to trigger the state transition. The other fields of a fulfillment can only be updated when the fulfillment is in the `Executing` state, or when the fulfillment is in the `Booked` state and the user has the "Allow Edit Of Booked Order Line Items" permission.
The following tutorial demonstrates how to use this operation:
* [Update or cancel a fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/H_Update_a_fulfillment)
operationId: PUT_Fulfillment
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The id or fulfillment number of the Fulfillment to update.
in: path
name: key
required: true
schema:
format: UUID
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PutFulfillmentRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update a fulfillment
tags:
- Fulfillments
/v1/fulfillment-items:
post:
description: |
Creates one or multiple fulfillment items.
operationId: Create_FulfillmentItem
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/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/PostFulfillmentItemsRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
fulfillmentItems:
- id: 4028828c82819b74018282544fea17c6
- id: 4028828c82819b7401828254507a17c7
success: true
schema:
$ref: '#/components/schemas/PostFulfillmentItemsResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Create fulfillment items
tags:
- Fulfillments
/v1/fulfillment-items/{id}:
delete:
description: |
Deletes a specified fulfillment item.
operationId: Delete_FulfillmentItem
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The id of the Fulfillment Item to delete.
in: path
name: id
required: true
schema:
format: UUID
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Delete a fulfillment item
tags:
- Fulfillments
get:
description: |
Retrieves the detailed information about a specified fulfillment item.
operationId: GET_FulfillmentItem
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The id of the Fulfillment Item to retrieve.
in: path
name: id
required: true
schema:
format: UUID
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
fulfillmentItem:
customFields:
PICKLIST_CF__c: option_2
description: item description
fulfillmentId: 4028828c82819b74018282572f6719b4
id: 4028828c82819b7401828257303a19b6
itemIdentifier: 5da7a054-24c6-4f29-866b-2c570d844fd0
success: true
schema:
$ref: '#/components/schemas/GetFulfillmentItemResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a fulfillment item
tags:
- Fulfillments
put:
description: |
Updates a specified fulfillment item.
operationId: PUT_FulfillmentItem
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The id of the Fulfillment Item to update.
in: path
name: id
required: true
schema:
format: UUID
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PutFulfillmentItemRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update a fulfillment item
tags:
- Fulfillments
/v1/ramps/{rampNumber}:
get:
description: |
**Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.
Retrieves the latest definition of a specified ramp.
operationId: GET_RampByRampNumber
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
The automatically generated number of a ramp. For example, R-00000268.
in: path
name: rampNumber
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ramp:
charges:
- chargeNumber: C-00000202
description: ''
id: 40289f7b7321f5ce0173229d798300cf
intervals:
- description: ''
endDate: '2020-12-31'
name: Year 1
startDate: '2020-01-01'
- description: ''
endDate: '2021-12-31'
name: Year 2
startDate: '2021-01-01'
name: Two Years Ramp
number: R-00000268
subscriptionNumber: A-S00000287
success: true
schema:
$ref: '#/components/schemas/GETRampByRampNumberResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a ramp
tags:
- Ramps
/v1/ramps/{rampNumber}/ramp-metrics:
get:
description: |
**Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.
Retrieves key metrics about a specified ramp, including the following metrics:
* TCB, TCV in the Ramp level
* TCB, TCV in the Interval level
* TCB, TCV, Quantity, and MRR in Interval Metrics
* Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta Metrics
See [Key metrics for Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/F_Key_metrics_for_Ramps) for more information.
operationId: GET_RampMetricsByRampNumber
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
The automatically generated number of a ramp. For example, R-00000268.
in: path
name: rampNumber
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
rampMetrics:
description: ''
discountTcb: 0
discountTcv: 0
grossTcb: 240
grossTcv: 240
intervals:
- description: ''
discountTcb: 0
discountTcv: 0
endDate: '2020-12-31'
grossTcb: 120
grossTcv: 120
intervalMetrics:
- chargeNumber: C-00000202
discountTcb: 0
discountTcv: 0
endDate: '2020-12-31'
grossTcb: 120
grossTcv: 120
mrr:
- discount: 0
endDate: '2020-12-31'
gross: 10
net: 10
startDate: '2020-01-01'
netTcb: 120
netTcv: 120
productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
quantity: 1
ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8
startDate: '2020-01-01'
subscriptionNumber: A-S00000287
name: Year 1
netTcb: 120
netTcv: 120
startDate: '2020-01-01'
- description: ''
discountTcb: 0
discountTcv: 0
endDate: '2021-12-31'
grossTcb: 120
grossTcv: 120
intervalMetrics:
- chargeNumber: C-00000202
discountTcb: 0
discountTcv: 0
endDate: '2021-12-31'
grossTcb: 120
grossTcv: 120
mrr:
- discount: 0
endDate: '2021-12-31'
gross: 10
net: 10
startDate: '2021-01-01'
netTcb: 120
netTcv: 120
productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
quantity: 1
ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8
startDate: '2021-01-01'
subscriptionNumber: A-S00000287
name: Year 2
netTcb: 120
netTcv: 120
startDate: '2021-01-01'
name: Two Years Ramp
netTcb: 240
netTcv: 240
number: R-00000268
success: true
schema:
$ref: '#/components/schemas/GETRampMetricsByRampNumberResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List all ramp metrics of a ramp
tags:
- Ramps
/v1/subscriptions/{subscriptionKey}/ramps:
get:
description: |
**Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.
Retrieves the definition of the ramp associated with a specified subscription.
operationId: GET_RampsBySubscriptionKey
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
The ID or number of an existing subscription.
in: path
name: subscriptionKey
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ramps:
- charges:
- chargeNumber: C-00000202
description: ''
id: 40289f7b7321f5ce0173229d798300cf
intervals:
- description: ''
endDate: '2020-12-31'
name: Year 1
startDate: '2020-01-01'
- description: ''
endDate: '2021-12-31'
name: Year 2
startDate: '2021-01-01'
name: Two Years Ramp
number: R-00000268
subscriptionNumber: A-S00000287
success: true
schema:
$ref: '#/components/schemas/GETRampsBySubscriptionKeyResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a ramp by subscription key
tags:
- Ramps
/v1/subscriptions/{subscriptionKey}/ramp-metrics:
get:
description: |
**Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.
Retrieves key ramp metrics about a specified subscription, including the following metrics:
* TCB, TCV in the Ramp level
* TCB, TCV in the Interval level
* TCB, TCV, Quantity, and MRR in Interval Metrics
* Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta Metrics
See [Key metrics for Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/F_Key_metrics_for_Ramps) for more information.
operationId: GET_RampMetricsBySubscriptionKey
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
The ID or number of an existing subscription.
in: path
name: subscriptionKey
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
rampMetrics:
description: ''
discountTcb: 0
discountTcv: 0
grossTcb: 240
grossTcv: 240
intervals:
- description: ''
discountTcb: 0
discountTcv: 0
endDate: '2020-12-31'
grossTcb: 120
grossTcv: 120
intervalMetrics:
- chargeNumber: C-00000202
discountTcb: 0
discountTcv: 0
endDate: '2020-12-31'
grossTcb: 120
grossTcv: 120
mrr:
- discount: 0
endDate: '2020-12-31'
gross: 10
net: 10
startDate: '2020-01-01'
netTcb: 120
netTcv: 120
productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
quantity: 1
ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8
startDate: '2020-01-01'
subscriptionNumber: A-S00000287
name: Year 1
netTcb: 120
netTcv: 120
startDate: '2020-01-01'
- description: ''
discountTcb: 0
discountTcv: 0
endDate: '2021-12-31'
grossTcb: 120
grossTcv: 120
intervalMetrics:
- chargeNumber: C-00000202
discountTcb: 0
discountTcv: 0
endDate: '2021-12-31'
grossTcb: 120
grossTcv: 120
mrr:
- discount: 0
endDate: '2021-12-31'
gross: 10
net: 10
startDate: '2021-01-01'
netTcb: 120
netTcv: 120
productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
quantity: 1
ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8
startDate: '2021-01-01'
subscriptionNumber: A-S00000287
name: Year 2
netTcb: 120
netTcv: 120
startDate: '2021-01-01'
name: Two Years Ramp
netTcb: 240
netTcv: 240
number: R-00000268
success: true
schema:
$ref: '#/components/schemas/GETRampMetricsBySubscriptionKeyResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List ramp metrics by subscription key
tags:
- Ramps
/v1/orders/{orderNumber}/ramp-metrics:
get:
description: |
**Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.
Retrieves key ramp metrics about a specified order, including the following metrics:
* TCB, TCV in the Ramp level
* TCB, TCV in the Interval level
* TCB, TCV, Quantity, and MRR in Interval Metrics
* Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta Metrics
See [Key metrics for Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/F_Key_metrics_for_Ramps) for more information.
operationId: GET_RampMetricsByOrderNumber
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
The number of the existing order.
in: path
name: orderNumber
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
rampMetrics:
- description: ''
discountTcb: 0
discountTcv: 0
grossTcb: 240
grossTcv: 240
intervals:
- description: ''
discountTcb: 0
discountTcv: 0
endDate: '2020-12-31'
grossTcb: 120
grossTcv: 120
intervalDeltaMetrics:
- chargeNumber: C-00000204
deltaDiscountTcb: 0
deltaDiscountTcv: 0
deltaGrossTcb: 120
deltaGrossTcv: 120
deltaMrr:
- discount: 0
endDate: '2020-12-31'
gross: 10
net: 10
startDate: '2020-01-01'
deltaNetTcb: 120
deltaNetTcv: 120
deltaQuantity:
- amount: 1
endDate: '2020-12-31'
startDate: '2020-01-01'
productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
subscriptionNumber: A-S00000289
intervalMetrics:
- chargeNumber: C-00000204
discountTcb: 0
discountTcv: 0
endDate: '2020-12-31'
grossTcb: 120
grossTcv: 120
mrr:
- discount: 0
endDate: '2020-12-31'
gross: 10
net: 10
startDate: '2020-01-01'
netTcb: 120
netTcv: 120
productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
quantity: 1
ratePlanChargeId: 40289f7b7322a15901732392a904000a
startDate: '2020-01-01'
subscriptionNumber: A-S00000289
name: Year 1
netTcb: 120
netTcv: 120
startDate: '2020-01-01'
- description: ''
discountTcb: 0
discountTcv: 0
endDate: '2021-12-31'
grossTcb: 120
grossTcv: 120
intervalDeltaMetrics:
- chargeNumber: C-00000204
deltaDiscountTcb: 0
deltaDiscountTcv: 0
deltaGrossTcb: 120
deltaGrossTcv: 120
deltaMrr:
- discount: 0
endDate: '2021-12-31'
gross: 10
net: 10
startDate: '2021-01-01'
deltaNetTcb: 120
deltaNetTcv: 120
deltaQuantity:
- amount: 1
endDate: '2021-12-31'
startDate: '2021-01-01'
productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
subscriptionNumber: A-S00000289
intervalMetrics:
- chargeNumber: C-00000204
discountTcb: 0
discountTcv: 0
endDate: '2021-12-31'
grossTcb: 120
grossTcv: 120
mrr:
- discount: 0
endDate: '2021-12-31'
gross: 10
net: 10
startDate: '2021-01-01'
netTcb: 120
netTcv: 120
productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
quantity: 1
ratePlanChargeId: 40289f7b7322a15901732392a904000a
startDate: '2021-01-01'
subscriptionNumber: A-S00000289
name: Year 2
netTcb: 120
netTcv: 120
startDate: '2021-01-01'
name: Two Years Ramp
netTcb: 240
netTcv: 240
number: R-00000270
success: true
schema:
$ref: '#/components/schemas/GETRampMetricsByOrderNumberResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List ramp metrics by order number
tags:
- Ramps
/v1/subscriptions/preview:
post:
description: |
The REST API reference describes how to create a new subscription in preview mode. This call does not require a valid customer account. It can be used to show potential new customers a preview of a subscription with complete details and charges before creating an account, or to let existing customers preview a subscription with all charges before committing.
**Notes**:
- The response of the Preview Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers.
- If you have the Invoice Settlement feature enabled, we recommend that you set the `zuora-version` parameter to `207.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error is returned.
- Default values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows.
| | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified |
| ------------- |:-------------| :-----|
| customerAcceptanceDate (CA) specified | SA uses value in the request call; CA uses value in the request call| CA uses value in the request call;SA uses CE as default |
| customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default |
operationId: POST_PreviewSubscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/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 minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTSubscriptionPreviewType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
contractedMrr: 14.99
totalContractedValue: 179.88
amount: 14.99
amountWithoutTax: 14.99
taxAmount: 0
invoiceTargetDate: '2024-07-11'
documentDate: '2024-07-11'
invoiceItems:
- serviceStartDate: '2024-07-01'
serviceEndDate: '2024-07-31'
chargeAmount: 14.99
taxAmount: 0
chargeDescription: ''
chargeName: Monthly Fee
productName: Music Service
productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38
quantity: 1
unitOfMeasure: ''
schema:
$ref: '#/components/schemas/POSTSubscriptionPreviewResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Preview a subscription
tags:
- Subscriptions
/v1/subscriptions/{subscription-key}/preview:
post:
description: |
Describes how to preview an existing subscription to view information about existing and future invoices or credit memos.
**Note**: The `zuora-version` parameter must be `207.0` or later.
operationId: PreviewExistingSubscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- description: |
The minor version of the Zuora REST API.
You need to set this parameter if you use the following fields:
* targetDate
* includeExistingDraftDocItems
* previewType
* taxationItems
If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned.
in: header
name: zuora-version
required: false
schema:
type: string
- description: Subscription number or ID
in: path
name: subscription-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewExistingSubscriptionRequest'
required: true
responses:
'200':
content:
application/json:
example:
invoices:
- invoiceNumber: Preview Invoice
amount: 10
amountWithoutTax: 10
taxAmount: 0
targetDate: '2024-02-01'
status: null
isFromExistingInvoice: false
invoiceItems:
- serviceStartDate: '2024-01-01'
serviceEndDate: '2024-01-31'
amountWithoutTax: 10
taxAmount: 0
chargeDescription: Recurring Flat Fee Pricing
chargeName: Recurring_Flat Fee Pricing1628472350306
chargeNumber: C-0000001
productName: P_1628472348863
productRatePlanChargeId: 402881547b216168017b2884182f12e7
processingType: Charge
unitPrice: 10
quantity: 1
unitOfMeasure: null
creditMemos:
- creditMemoNumber: Preview Credit Memo
amount: 10
amountWithoutTax: 10
taxAmount: 0
targetDate: '2024-02-01'
status: null
isFromExistingCreditMemo: false
creditMemoItems:
- serviceStartDate: '2024-01-01'
serviceEndDate: '2024-01-31'
amountWithoutTax: 10
taxAmount: 0
chargeDescription: Recurring Flat Fee Pricing
chargeName: Recurring_Flat Fee Pricing1628472350306
chargeNumber: C-0000001
productName: P_1628472348863
productRatePlanChargeId: 402881547b216168017b2884182f12e7
processingType: Charge
unitPrice: 10
quantity: 1
unitOfMeasure: null
success: true
schema:
$ref: '#/components/schemas/PreviewExistingSubscriptionResponse'
description: OK
headers:
Content-Encoding:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
RateLimit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
RateLimit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
RateLimit-Reset:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Preview a subscription by subscription key
tags:
- Subscriptions
x-accepts: application/json
x-codegen-request-body-name: Request
x-content-type: application/json
/v1/subscriptions:
post:
description: |
This REST API reference describes how to create a new subscription for an existing customer account.
### Notes
If you have the Invoice Settlement feature enabled, it is best practice to set
the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).
Otherwise, an error occurs.
Default values for **customerAcceptanceDate** and **serviceActivationDate** are
set as follows. This API operation does not support creating a pending subscription.
| | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified |
| ------------- |:------------- | :-----|
| customerAcceptanceDate (CA) specified| SA uses value in the request call; CA uses value in the request call| CA uses value in the request call;SA uses CE as default |
| customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default |
operationId: POST_Subscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/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 minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTSubscriptionType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
subscriptionId: 8ad087d290a5e7330190b98577936eaf
subscriptionNumber: A-S00000141
contractedMrr: 14.99
totalContractedValue: 179.88
schema:
$ref: '#/components/schemas/POSTSubscriptionResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Create a subscription
tags:
- Subscriptions
/v1/subscriptions/accounts/{account-key}:
get:
description: |
Retrieves all subscriptions associated with the specified account. Zuora only returns the latest version of the subscriptions.
Subscription data is returned in reverse chronological order based on `updatedDate`. Note that the rate plans inside the subscriptions are not sorted specifically and are returned in a random order.
operationId: GET_SubscriptionsByAccount
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_REQUEST_page'
- $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
- description: |
Possible values are:
* an account number
* an account ID
in: path
name: account-key
required: true
schema:
type: string
- description: |
The segmented rate plan charges.
When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.
Possible values are:
* __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates.
* __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate).
* __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.
* __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd.
in: query
name: charge-detail
required: false
schema:
type: string
- description: |
If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`.
in: query
name: exclude-rate-plans-with-no-charges
required: false
schema:
type: boolean
- description: |2-
If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response.
The default value is `false`.
in: query
name: getDetailedMetrics
schema:
type: boolean
default: false
- description: |-
The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`.
The default value is the current date.
in: query
name: asOfDay
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
subscriptions:
- accountId: 8a8082c45aa81b51015ad64396090f5c
accountName: ABCD
accountNumber: A00002641
autoRenew: true
billToContact:
address1: ''
address2: ''
city: ''
country: null
county: null
fax: ''
firstName: Test
homePhone: ''
id: 2c9081a03c6d7b51013c6d7e46c80a17
lastName: Test
mobilePhone: ''
nickname: ''
otherPhone: ''
otherPhoneType: null
personalEmail: ''
state: ''
taxRegion: null
workEmail: contact@example.com
workPhone: ''
zipCode: ''
contractEffectiveDate: '2017-01-01'
contractedMrr: 8.33
contractedNetMrr: 8.33
asOfDayGrossMrr: 8.33
asOfDayNetMrr: 8.33
netTotalContractedValue: 8.33
currency: USD
currentTerm: 12
currentTermPeriodType: Month
customerAcceptanceDate: '2017-01-01'
id: 8a8082c45aa81b51015ad68743ec0fdb
initialTerm: 12
initialTermPeriodType: Month
invoiceGroupNumber: N-0001
invoiceOwnerAccountId: 8a8082c45aa81b51015ad64396090f5c
invoiceOwnerAccountName: ABCD
invoiceOwnerAccountNumber: A00002641
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
invoiceSeparately: false
invoiceTemplateId: 2c9081a03c638994013c63978baf002b
invoiceTemplateName: InvoiceTemplateName
notes: ''
paymentTerm: Net 30
ratePlans:
- id: 8a8082c45aa81b51015ad68744030fe3
productId: 8a8082c45aa81b51015ad5a2d07d0e89
productName: ABC
productRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d
productSku: SKU-00000987
contractedNetMrr: 8.33
contractedMrr: 8.33
asOfDayGrossMrr: 8.33
asOfDayNetMrr: 8.33
netTotalContractedValue: 8.33
ratePlanCharges:
- applyDiscountTo: null
billingDay: DefaultFromCustomer
billingPeriod: Annual
billingPeriodAlignment: AlignToCharge
billingTiming: IN_ADVANCE
chargedThroughDate: null
currency: USD
description: ''
discountAmount: null
discountApplyDetails: null
discountClass: null
discountLevel: null
discountPercentage: null
dmrc: 8.333333
done: false
dtcv: 100
effectiveEndDate: '2018-01-01'
effectiveStartDate: '2017-01-01'
endDateCondition: Subscription_End
id: 8a8082c45aa81b51015ad68744160fe4
includedUnits: null
invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
listPriceBase: Per_Billing_Period
model: FlatFee
mrr: 8.333333
name: Annual Charge
number: C-00032238
numberOfPeriods: null
originalChargeId: 8a8082c45aa81b51015ad68744160fe4
overageCalculationOption: null
overagePrice: null
overageUnusedUnitsCreditOption: null
price: 100
priceChangeOption: NoChange
priceIncreasePercentage: null
pricingSummary: USD100
processedThroughDate: null
productRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f
quantity: 1
segment: 1
smoothingModel: null
specificBillingPeriod: null
specificEndDate: null
tcv: 100
tiers: null
triggerDate: null
triggerEvent: ContractEffective
type: Recurring
unusedUnitsCreditRates: null
uom: null
upToPeriods: null
upToPeriodsType: null
usageRecordRatingOption: null
version: 1
- applyDiscountTo: ONETIMERECURRINGUSAGE
billingDay: DefaultFromCustomer
billingPeriod: Month
billingPeriodAlignment: AlignToCharge
billingTiming: null
chargedThroughDate: null
currency: USD
description: ''
discountAmount: 10
discountApplyDetails:
- appliedProductName: ABC
appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f
appliedProductRatePlanChargeName: Annual Charge
appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d
appliedProductRatePlanName: RatePlan 1
- appliedProductName: ABC
appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f
appliedProductRatePlanChargeName: Annual Charge
appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d
appliedProductRatePlanName: RatePlan 1
discountClass: VIP Discount
discountLevel: subscription
discountPercentage: null
dmrc: 0
done: false
dtcv: 0
effectiveEndDate: '2018-01-01'
effectiveStartDate: '2017-01-01'
endDateCondition: Subscription_End
id: 8a8082c45aa81b51015ad68744240fe5
includedUnits: null
invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
listPriceBase: null
model: DiscountFixedAmount
mrr: 0
name: Discount-Fixed 10
number: C-00032239
numberOfPeriods: null
originalChargeId: 8a8082c45aa81b51015ad68744240fe5
overageCalculationOption: null
overagePrice: null
overageUnusedUnitsCreditOption: null
price: null
priceChangeOption: null
priceIncreasePercentage: null
pricingSummary: USD10 fixed amount discount
processedThroughDate: null
productRatePlanChargeId: 8a8082c45aa81b51015ad683bc590fd8
quantity: null
segment: 1
smoothingModel: null
specificBillingPeriod: null
specificEndDate: null
tcv: 0
tiers: null
triggerDate: null
triggerEvent: ContractEffective
type: Recurring
unusedUnitsCreditRates: null
uom: null
upToPeriods: null
upToPeriodsType: null
usageRecordRatingOption: null
version: 1
- amendedByOrderOn: null
applyDiscountTo: null
billingDay: DefaultFromCustomer
billingPeriod: Month
billingPeriodAlignment: AlignToCharge
billingTiming: IN_ADVANCE
chargeModelConfiguration: null
chargedThroughDate: null
currency: USD
description: ''
discountAmount: null
discountApplyDetails: null
discountClass: null
discountLevel: null
discountPercentage: null
dmrc: 38.571428571
done: false
dtcv: 468
effectiveEndDate: '2026-01-01'
effectiveStartDate: '2024-12-31'
endDateCondition: Subscription_End
id: 4028818386ba85070186bab54f99573d
includedUnits: null
inputArgumentId: null
invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
listPriceBase: Per_Billing_Period
model: Delivery
mrr: 38.571428571
name: Delivery Charge
number: C-00032240
numberOfDeliveries: 52
numberOfPeriods: null
originalChargeId: 4028818386ba85070186bab54f065731
originalOrderDate: '2023-01-01'
overageCalculationOption: null
overagePrice: null
overageUnusedUnitsCreditOption: null
price: 9
priceChangeOption: null
priceIncreasePercentage: null
pricingSummary: ''
processedThroughDate: null
productRatePlanChargeId: 4028818386b61be50186b6293eb30017
quantity: 1
ratingGroup: null
segment: 3
smoothingModel: null
specificBillingPeriod: null
specificEndDate: null
subscriptionChargeDeliverySchedule:
dayOfMonth: null
frequency: Weekly
friday: false
monday: false
monthOfYear: null
saturday: false
sunday: true
thursday: false
tuesday: false
wednesday: false
subscriptionChargeIntervalPricing:
- duration: 365
price: 5
sequence: 1
subscriptionChargeIntervalPriceTiers: []
type: Day
- duration: 365
price: 7
sequence: 2
subscriptionChargeIntervalPriceTiers: []
type: Day
- duration: null
price: 9
sequence: 3
subscriptionChargeIntervalPriceTiers: []
type: Infinity
tcv: 468
tiers: null
triggerDate: null
triggerEvent: ContractEffective
type: Recurring
unusedUnitsCreditRates: null
uom: null
upToPeriods: null
upToPeriodsType: null
usageRecordRatingOption: null
version: 1
ratePlanName: RatePlan 1
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerm: 12
renewalTermPeriodType: Month
revision: '1.0'
sequenceSetId: 6abcc30846de11e990900242ac1f0003
sequenceSetName: DEFAULT
serviceActivationDate: '2017-01-01'
soldToContact:
address1: ''
address2: ''
city: ''
country: null
county: null
fax: ''
firstName: Test
homePhone: ''
id: 2c9081a03c6d7b51013c6d7e46c80a17
lastName: Test
mobilePhone: ''
nickname: ''
otherPhone: ''
otherPhoneType: null
personalEmail: ''
state: ''
taxRegion: null
workEmail: contact@example.com
workPhone: ''
zipCode: ''
status: Active
subscriptionNumber: A-S00007412
subscriptionStartDate: '2017-01-01'
termEndDate: '2018-01-01'
termStartDate: '2017-01-01'
termType: TERMED
totalContractedValue: 100
version: 1
success: true
schema:
$ref: '#/components/schemas/GETSubscriptionWrapper'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List subscriptions by account key
tags:
- Subscriptions
/v1/subscriptions/{subscription-key}:
get:
description: |
This REST API reference describes how to retrieve detailed information
about a specified subscription in the latest version.
operationId: GET_SubscriptionsByKey
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
Possible values are:
* a subscription number
* a subscription ID
in: path
name: subscription-key
required: true
schema:
type: string
- description: |
The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.
Possible values are:
* __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates.
* __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate).
* __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.
* __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified ((specific date = effectiveStartDate) OR (effectiveStartDate < specific date < effectiveEndDate)). The format of the date is yyyy-mm-dd.
in: query
name: charge-detail
required: false
schema:
type: string
- description: |
If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`.
in: query
name: exclude-rate-plans-with-no-charges
required: false
schema:
type: boolean
- description: |2-
If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response.
The default value is `false`.
in: query
name: getDetailedMetrics
schema:
type: boolean
default: false
- description: |-
The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`.
The default value is the current date.
in: query
name: asOfDay
schema:
type: string
- description: 'Retrieves the invoice owner of a subscription. If this parameter is set to `true`, the invoice owner account details `invoiceOwnerAccountDetails` will be in the response. '
in: query
name: getInvoiceOwnerDetails
schema:
type: boolean
- description: 'Retrieves the owner of a subscription. If this parameter is set to `true`, the subscription owner account details `accountOwnerDetails` will be in the response. '
in: query
name: getSubscriptionOwnerDetails
schema:
type: boolean
responses:
'200':
content:
application/json:
examples:
response:
value:
accountId: 8a8082c45aa81b51015ad64396090f5c
accountName: ABCD
accountNumber: A00002641
accountOwnerDetails:
accountNumber: A00000001
batch: Batch1
communicationProfileId: 303d186840e611df817c002185d714e1
crmId: ''
id: 402892c74c9193cd014c91d35b0a0132
invoiceTemplateId: null
name: Test
notes: ''
partnerAccount: false
profileNumber: CP-00000012
salesRep: ''
sequenceSetId: null
status: Active
summaryStatementTemplateId: null
purchaseOrderNumber: ''
invoiceOwnerAccountDetails:
accountNumber: A00000001
batch: Batch1
communicationProfileId: 303d186840e611df817c002185d714e1
crmId: ''
id: 402892c74c9193cd014c91d35b0a0132
invoiceTemplateId: null
name: Test
notes: ''
partnerAccount: false
profileNumber: CP-00000012
salesRep: ''
sequenceSetId: null
status: Active
autoRenew: true
contractEffectiveDate: '2017-01-01'
contractedMrr: 8.33
contractedNetMrr: 8.33
asOfDayGrossMrr: 8.33
asOfDayNetMrr: 8.33
netTotalContractedValue: 8.33
currency: USD
currentTerm: 12
currentTermPeriodType: Month
customerAcceptanceDate: '2017-01-01'
id: 8a8082c45aa81b51015ad68743ec0fdb
initialTerm: 12
initialTermPeriodType: Month
invoiceGroupNumber: N-0001
invoiceOwnerAccountId: 8a8082c45aa81b51015ad64396090f5c
invoiceOwnerAccountName: ABCD
invoiceOwnerAccountNumber: A00002641
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
invoiceSeparately: false
invoiceTemplateId: 2c9081a03c638994013c63978baf002b
invoiceTemplateName: InvoiceTemplateName
notes: ''
paymentTerm: Net 30
ratePlans:
- id: 8a8082c45aa81b51015ad68744030fe3
productId: 8a8082c45aa81b51015ad5a2d07d0e89
productName: ABC
productRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d
productSku: SKU-00000987
contractedNetMrr: 8.33
contractedMrr: 8.33
asOfDayGrossMrr: 8.33
asOfDayNetMrr: 8.33
netTotalContractedValue: 8.33
ratePlanCharges:
- applyDiscountTo: null
billingDay: DefaultFromCustomer
billingPeriod: Annual
billingPeriodAlignment: AlignToCharge
billingTiming: IN_ADVANCE
chargedThroughDate: null
currency: USD
description: ''
discountAmount: null
discountApplyDetails: null
discountClass: null
discountLevel: null
discountPercentage: null
dmrc: 8.333333
done: false
dtcv: 100
effectiveEndDate: '2018-01-01'
effectiveStartDate: '2017-01-01'
endDateCondition: Subscription_End
id: 8a8082c45aa81b51015ad68744160fe4
includedUnits: null
invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
listPriceBase: Per_Billing_Period
model: FlatFee
mrr: 8.333333
name: Annual Charge
number: C-00032238
numberOfPeriods: null
originalChargeId: 8a8082c45aa81b51015ad68744160fe4
overageCalculationOption: null
overagePrice: null
overageUnusedUnitsCreditOption: null
price: 100
priceChangeOption: NoChange
priceIncreasePercentage: null
pricingSummary: USD100
processedThroughDate: null
productRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f
quantity: 1
segment: 1
smoothingModel: null
specificBillingPeriod: null
specificEndDate: null
tcv: 100
tiers: null
triggerDate: null
triggerEvent: ContractEffective
type: Recurring
unusedUnitsCreditRates: null
uom: null
upToPeriods: null
upToPeriodsType: null
usageRecordRatingOption: null
version: 1
- applyDiscountTo: ONETIMERECURRINGUSAGE
billingDay: DefaultFromCustomer
billingPeriod: Month
billingPeriodAlignment: AlignToCharge
billingTiming: null
chargedThroughDate: null
currency: USD
description: ''
discountAmount: 10
discountApplyDetails:
- appliedProductName: ABC
appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f
appliedProductRatePlanChargeName: Annual Charge
appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d
appliedProductRatePlanName: RatePlan 1
discountClass: VIP Discount
discountLevel: subscription
discountPercentage: null
dmrc: 0
done: false
dtcv: 0
effectiveEndDate: '2018-01-01'
effectiveStartDate: '2017-01-01'
endDateCondition: Subscription_End
id: 8a8082c45aa81b51015ad68744240fe5
includedUnits: null
invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
listPriceBase: null
model: DiscountFixedAmount
mrr: 0
name: Discount-Fixed 10
number: C-00032239
numberOfPeriods: null
originalChargeId: 8a8082c45aa81b51015ad68744240fe5
overageCalculationOption: null
overagePrice: null
overageUnusedUnitsCreditOption: null
price: null
priceChangeOption: null
priceIncreasePercentage: null
pricingSummary: USD10 fixed amount discount
processedThroughDate: null
productRatePlanChargeId: 8a8082c45aa81b51015ad683bc590fd8
quantity: null
segment: 1
smoothingModel: null
specificBillingPeriod: null
specificEndDate: null
tcv: 0
tiers: null
triggerDate: null
triggerEvent: ContractEffective
type: Recurring
unusedUnitsCreditRates: null
uom: null
upToPeriods: null
upToPeriodsType: null
usageRecordRatingOption: null
version: 1
- amendedByOrderOn: null
applyDiscountTo: null
billingDay: DefaultFromCustomer
billingPeriod: Month
billingPeriodAlignment: AlignToCharge
billingTiming: IN_ADVANCE
chargeModelConfiguration: null
chargedThroughDate: null
currency: USD
description: ''
discountAmount: null
discountApplyDetails: null
discountClass: null
discountLevel: null
discountPercentage: null
dmrc: 38.571428571
done: false
dtcv: 468
effectiveEndDate: '2026-01-01'
effectiveStartDate: '2024-12-31'
endDateCondition: Subscription_End
id: 4028818386ba85070186bab54f99573d
includedUnits: null
inputArgumentId: null
invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
listPriceBase: Per_Billing_Period
model: Delivery
mrr: 38.571428571
name: Delivery Charge
number: C-00032240
numberOfDeliveries: 52
numberOfPeriods: null
originalChargeId: 4028818386ba85070186bab54f065731
originalOrderDate: '2023-01-01'
overageCalculationOption: null
overagePrice: null
overageUnusedUnitsCreditOption: null
price: 9
priceChangeOption: null
priceIncreasePercentage: null
pricingSummary: ''
processedThroughDate: null
productRatePlanChargeId: 4028818386b61be50186b6293eb30017
quantity: 1
ratingGroup: null
segment: 3
smoothingModel: null
specificBillingPeriod: null
specificEndDate: null
subscriptionChargeDeliverySchedule:
dayOfMonth: null
frequency: Weekly
friday: false
monday: false
monthOfYear: null
saturday: false
sunday: true
thursday: false
tuesday: false
wednesday: false
subscriptionChargeIntervalPricing:
- duration: 365
price: 5
sequence: 1
subscriptionChargeIntervalPriceTiers: []
type: Day
- duration: 365
price: 7
sequence: 2
subscriptionChargeIntervalPriceTiers: []
type: Day
- duration: null
price: 9
sequence: 3
subscriptionChargeIntervalPriceTiers: []
type: Infinity
tcv: 468
tiers: null
triggerDate: null
triggerEvent: ContractEffective
type: Recurring
unusedUnitsCreditRates: null
uom: null
upToPeriods: null
upToPeriodsType: null
usageRecordRatingOption: null
version: 1
ratePlanName: RatePlan 1
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerm: 12
renewalTermPeriodType: Month
revision: '1.0'
sequenceSetId: 6abcc30846de11e990900242ac1f0003
sequenceSetName: DEFAULT
serviceActivationDate: '2017-01-01'
billToContact:
address1: ''
address2: ''
city: ''
country: null
county: null
fax: ''
firstName: Test
homePhone: ''
id: 2c9081a03c6d7b51013c6d7e46c80a17
lastName: Test
mobilePhone: ''
nickname: ''
otherPhone: ''
otherPhoneType: null
personalEmail: ''
state: ''
taxRegion: null
workEmail: contact@example.com
workPhone: ''
zipCode: ''
soldToContact:
address1: ''
address2: ''
city: ''
country: null
county: null
fax: ''
firstName: Test
homePhone: ''
id: 2c9081a03c6d7b51013c6d7e46c80a17
lastName: Test
mobilePhone: ''
nickname: ''
otherPhone: ''
otherPhoneType: null
personalEmail: ''
state: ''
taxRegion: null
workEmail: contact@example.com
workPhone: ''
zipCode: ''
status: Active
subscriptionNumber: A-S00007412
subscriptionStartDate: '2017-01-01'
success: true
termEndDate: '2018-01-01'
termStartDate: '2017-01-01'
termType: TERMED
totalContractedValue: 100
version: 1
schema:
$ref: '#/components/schemas/GETSubscriptionByKeyWithSuccess'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a subscription by key
tags:
- Subscriptions
put:
description: |
Use this call to make the following kinds of changes to a subscription:
- Add a note
- Change the renewal term or auto-renewal flag
- Change the term length or change between evergreen and termed
- Add a new product rate plan
- Remove an existing subscription rate plan
- Change the quantity or price of an existing subscription rate plan
- Change rate plans - to replace the existing rate plans in a subscription with other rate plans. Changing rate plans is currently not supported for the Billing - Revenue Integration feature. When Billing - Revenue Integration is enabled, changing rate plans will no longer be applicable in Zuora Billing.
### Notes:
- The "Update a subscription" call creates a new subscription object that has a new version number and to which the subscription changes are applied. The new subscription object has the same subscription name but a new, different, subscription ID. The `Status` field of the new subscription object will be set to `Active` unless the change applied was a cancelation or suspension in which case the status reflects that. The `Status` field of the originating subscription object changes from `Active` to `Expired`. A status of `Expired` does not imply that the subscription itself has expired or ended, merely that this subscription object is no longer the most recent.
- In one request, this call can make:
- Up to 9 combined add, update, and remove changes
- No more than 1 change to terms & conditions
- Updates are performed in the following sequence:
1. First change the notes on the existing subscription, if requested.
2. Then change the terms and conditions, if requested.
3. Then perform the remaining amendments based upon the effective dates specified. If multiple amendments have the same contract-effective dates, then execute adds before updates, and updates before removes.
- The update operation is atomic. If any of the updates fails, the entire operation is rolled back.
- The response of the Update Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers.
- If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs.
### Override a Tiered Price
There are two ways you override a tiered price:
- Override a specific tier number. For example: `tiers[{tier:1,price:8},{tier:2,price:6}]`
- Override the entire tier structure. For example: `tiers[{tier:1,price:8,startingUnit:1,endingUnit:100,priceFormat:"FlatFee"}, {tier:2,price:6,startingUnit:101,priceFormat:"FlatFee"}]`
If you just override a specific tier, do not include the `startingUnit` field in the request.
operationId: PUT_Subscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/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 minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
- description: |
Subscription number or ID.
ID can be the latest version or any history version of ID.
* To make sure you update the last version of the subscription, use one of the following operations to retrieve the last version of ID:
* [List subscriptions by account key](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByAccount)
* [Retrieve a subscription by key](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByKey) by using the subscription number as the subscription-key
* If you want to use any history version of ID, the `STABLE_ID_PUBLIC_API` permission must be enabled. Submit a request at [Zuora Global Support](http://support.zuora.com/) to enable the permission. To retrieve a history version of ID, use the [Retrieve a subscription by key and version](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByKeyAndVersion) operation.
in: path
name: subscription-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTSubscriptionType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
subscriptionId: 4028bb83510f8ed7015114a503cf0373
success: true
totalDeltaMrr: 100
totalDeltaTcv: 4867.7419355
schema:
$ref: '#/components/schemas/PUTSubscriptionResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update a subscription
tags:
- Subscriptions
/v1/subscriptions/{subscription-key}/versions/{version}:
get:
description: |
This REST API reference describes how to retrieve detailed information about a specified subscription in a specified version. When you create a subscription amendment, you create a new version of the subscription. You can use this method to retrieve information about a subscription in any version.
operationId: GET_SubscriptionsByKeyAndVersion
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: |
Subscription number. For example, A-S00000135.
in: path
name: subscription-key
required: true
schema:
type: string
- description: |
Subscription version. For example, 1.
in: path
name: version
required: true
schema:
type: string
- description: |
The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.
Possible values are:
* __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates.
* __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate).
* __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.
* __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd.
in: query
name: charge-detail
required: false
schema:
type: string
- description: |
If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`.
in: query
name: exclude-rate-plans-with-no-charges
required: false
schema:
type: boolean
- description: |2-
If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response.
The default value is `false`.
in: query
name: getDetailedMetrics
schema:
type: boolean
default: false
- description: |-
The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`.
The default value is the current date.
in: query
name: asOfDay
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
accountId: 2c9081a03c63c94c013c66688a2c00bf
accountName: RestAPI
accountNumber: RestAPI
autoRenew: false
contractEffectiveDate: '2012-02-01'
contractedMrr: 26.67
contractedNetMrr: 26.67
asOfDayGrossMrr: 26.67
asOfDayNetMrr: 26.67
netTotalContractedValue: 26.67
currency: USD
currentTerm: 12
currentTermPeriodType: Week
customerAcceptanceDate: '2012-02-01'
id: 2c9081a03c63c94c013c687b864e0195
initialTermPeriodType: Week
invoiceGroupNumber: N-0001
invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
notes: ''
ratePlans:
- id: 2c9081a03c63c94c013c687b868901a4
productId: 2c9081a03c63c94c013c66499ef0001b
productName: OneTime
productRatePlanId: 2c9081a03c63c94c013c665102e5003a
productSku: SKU-00000022
contractedNetMrr: 26.67
contractedMrr: 26.67
asOfDayGrossMrr: 26.67
asOfDayNetMrr: 26.67
netTotalContractedValue: 26.67
ratePlanCharges:
- applyDiscountTo: null
billingDay: null
billingPeriod: null
billingPeriodAlignment: null
billingTiming: null
chargedThroughDate: '2012-02-02'
currency: USD
description: ''
discountAmount: null
discountLevel: null
discountPercentage: null
dmrc: null
done: true
dtcv: 24
effectiveEndDate: '2012-02-02'
effectiveStartDate: '2012-02-01'
endDateCondition: One_Time
id: 2c9081a03c63c94c013c687b868901a5
includedUnits: null
invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
listPriceBase: null
model: Tiered
mrr: null
name: OT_Tiered
number: C-00000010
numberOfPeriods: null
originalChargeId: 2c9081a03c63c94c013c687a92d70175
overageCalculationOption: null
overagePrice: null
overageUnusedUnitsCreditOption: null
price: null
priceChangeOption: null
priceIncreasePercentage: null
pricingSummary: '0 to 10 Each: USD20 flat fee; 11 Each or more: USD4/Each'
processedThroughDate: '2012-02-02'
productRatePlanChargeId: 2c9081a03c63c94c013c6651d677003c
quantity: 11
segment: 1
smoothingModel: null
specificBillingPeriod: null
specificEndDate: null
tcv: 24
tiers:
- endingUnit: 10
price: 20
priceFormat: FlatFee
startingUnit: 0
tier: 1
- endingUnit: null
price: 4
priceFormat: PerUnit
startingUnit: 11
tier: 2
triggerDate: null
triggerEvent: ContractEffective
type: OneTime
unusedUnitsCreditRates: null
uom: Each
upToPeriods: null
upToPeriodsType: null
usageRecordRatingOption: null
version: 1
ratePlanName: OT_Tiered
renewalSetting: RENEW_WITH_SPECIFIC_TERM
renewalTerm: 0
renewalTermPeriodType: Week
revision: '1.0'
serviceActivationDate: '2012-02-01'
status: Active
subscriptionNumber: A-S00000004
subscriptionStartDate: '2012-02-01'
success: true
termEndDate: '2013-02-01'
termStartDate: '2012-02-01'
termType: TERMED
totalContractedValue: 404
version: 1
schema:
$ref: '#/components/schemas/GETSubscriptionTypeWithSuccess'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a subscription by key and version
tags:
- Subscriptions
/v1/subscriptions/{subscription-key}/renew:
put:
description: |
Renews a termed subscription using existing renewal terms. When you renew a subscription, the current subscription term is extended by creating a new term. If any charge in your subscription has the billing period set as `SubscriptionTerm`, a new charge segment is generated for the new term.
**Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs.
operationId: PUT_RenewSubscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/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 minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
- description: Subscription number or ID
in: path
name: subscription-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTRenewSubscriptionType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
subscriptionId: 2c92c8f83dcbd8b1013dcce0f09100a5
success: true
termEndDate: '2014-05-01'
termStartDate: '2014-02-01'
schema:
$ref: '#/components/schemas/PUTRenewSubscriptionResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Renew a subscription
tags:
- Subscriptions
/v1/subscriptions/{subscription-key}/cancel:
put:
description: |
This REST API reference describes how to cancel an active subscription.
**Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs.
operationId: PUT_CancelSubscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/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 minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
- description: Subscription number or ID. Subscription status must be `Active`.
in: path
name: subscription-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTSubscriptionCancellationType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
cancelledDate: '2019-05-31'
invoiceId: 8a8082c453cd2a620153e426c7eb78b3
subscriptionId: 8a8082c453cd2a620154efc7bba0350e
success: true
totalDeltaMrr: 0
totalDeltaTcv: -703.2258065
schema:
$ref: '#/components/schemas/POSTSubscriptionCancellationResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Cancel a subscription
tags:
- Subscriptions
/v1/subscriptions/{subscription-key}/resume:
put:
description: |
This REST API reference describes how to resume a suspended subscription.
**Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs.
operationId: PUT_ResumeSubscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/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 minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
- description: Subscription number or ID. Subscription status must be Suspended.
in: path
name: subscription-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTSubscriptionResumeType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
subscriptionId: 6429c37b5a392e093172e68779c24021
resumeDate: '2024-11-01'
termEndDate: '2025-01-13'
totalDeltaTcv: 167.070913965
schema:
$ref: '#/components/schemas/PUTSubscriptionResumeResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Resume a subscription
tags:
- Subscriptions
/v1/subscriptions/{subscription-key}/suspend:
put:
description: |
This REST API reference describes how to suspend an active subscription.
**Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs.
operationId: PUT_SuspendSubscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/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 minor API version.
For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
in: header
name: zuora-version
required: false
schema:
type: string
- description: Subscription number or ID. Subscription status must be Active.
in: path
name: subscription-key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTSubscriptionSuspendType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
subscriptionId: 8ad0937890e7fca00190fd3ff7ca7f08
suspendDate: '2024-07-28'
resumeDate: null
termEndDate: '2025-07-22'
totalDeltaTcv: -176.978709679
schema:
$ref: '#/components/schemas/PUTSubscriptionSuspendResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Suspend a subscription
tags:
- Subscriptions
/v1/subscriptions/{subscription-key}/delete:
put:
description: |
This REST API reference describes how to delete a subscription of the specified subscription number.
operationId: PUT_DeleteSubscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: Subscription number
in: path
name: subscription-key
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/PUTDeleteSubscriptionResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Delete a subscription by number
tags:
- Subscriptions
/v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields:
put:
description: |
Updates the custom fields of a specified subscription version.
operationId: PUT_UpdateSubscriptionCustomFieldsOfASpecifiedVersion
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The subscription number to be updated.
in: path
name: subscriptionNumber
required: true
schema:
format: string
type: string
- description: The subscription version to be updated.
in: path
name: version
required: true
schema:
format: string
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PUTSubscriptionPatchSpecificVersionRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Update subscription custom fields of a subscription version
tags:
- Subscriptions
/v1/subscriptions/subscription-metrics:
get:
description: |
Lists subscription metrics for the subscriptions that you specify by subscription numbers.
operationId: GetMetricsBySubscriptionNumbers
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The date for the metrics. The date should be in the format `YYYY-MM-DD`. The default value is the current date.
in: query
name: asOfDay
schema:
type: string
- description: The subscription numbers of existing subscriptions.
in: query
name: subscriptionNumbers[]
required: true
schema:
type: array
items:
type: string
responses:
'200':
content:
application/json:
example:
subscriptionMetrics:
- subscriptionNumber: A-S00000008
contractedMrr: 100
contractedNetMrr: 100
asOfDayGrossMrr: 100
asOfDayNetMrr: 100
netTotalContractedValue: 100
totalContractedValue: 100
- subscriptionNumber: A-S00000009
contractedMrr: 100
contractedNetMrr: 100
asOfDayGrossMrr: 100
asOfDayNetMrr: 100
netTotalContractedValue: 100
totalContractedValue: 100
success: true
schema:
$ref: '#/components/schemas/GETMetricsBySubscriptionNumbersResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List subscription metrics by subscription numbers
tags:
- Subscriptions
/v1/rateplans/{ratePlanId}:
get:
description: |
Retrieves the detailed information about a specific subscription rate plan.
- If you have the Orders
feature enabled, this operation retrieves information about a subscription rate
plan and the related order that has amended the rate plan.
- If you have the Orders Harmonization
feature enabled, this operation retrieves information about a subscription rate plan and the related order and amendment that have amended the rate plan.
The returned objects may be different since amendment, order, and order action are generated asynchronously.
- If all are generated, the related amendment and order, including the order action, are returned.
- If not, only the related amendment may be returned before generating the order and order action.
- If you are an existing Zuora Subscribe and Amend customer, this operation retrieves
information about a subscription rate plan and the related amendment that has
amended the rate plan.
**Note:** Orders is now generally available as of Zuora Billing Release 284 (August
2020). If you are an existing Zuora Subscribe and Amend customer and want to adopt
Orders, see What is Orders Harmonization
and join the Orders Harmonization community group
for more information. If you want to enable Orders, submit a request at Zuora
Global Support.
**Note:** You can only retrieve information about the following order actions:
- `addProduct`
- `updateProduct`
- `removeProduct`
- `changePlan`
operationId: GET_RatePlan
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The ID of the subscription rate plan to be retrieved.
in: path
name: ratePlanId
required: true
schema:
format: string
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
amendment:
code: A-AM00000047
contractEffectiveDate: '2021-12-29'
createdBy: 2c9890207c9649c0017c969bc6330002
createdDate: '2021-10-29 19:44:16'
customerAcceptanceDate: '2021-12-29'
description: null
effectiveDate: '2021-12-29'
id: 402880e47ccbaca1017ccbdd63c818cb
name: update
serviceActivationDate: '2021-12-29'
type: UpdateProduct
updatedBy: 2c9890207c9649c0017c969bc6330002
updatedDate: '2021-10-29 19:44:16'
id: 402880e47ccbaca1017ccbdd63aa18c8
lastChangeType: Update
order:
id: 402880e47ccbaca1017ccbdd7b0e18fd
orderActions:
- contractEffectiveDate: '2021-12-29'
customerAcceptanceDate: '2021-12-29'
id: 402880e47ccbaca1017ccbdd7b1418ff
serviceActivationDate: '2021-12-29'
type: UpdateProduct
updateProduct:
chargeUpdates: []
customFields: {}
newRatePlanId: 402880e47ccbaca1017ccbdd63aa18c8
productRatePlanId: 2c9890207c9649c0017c96a0f11001a4
ratePlanId: 402880e47ccbaca1017ccbdd620818ba
specificUpdateDate: null
uniqueToken: null
orderNumber: O-00000037
productId: 2c9890207c9649c0017c96a0588201a2
productName: MMORPG game
productRatePlanId: 2c9890207c9649c0017c96a0f11001a4
productSku: SKU-00000001
ratePlanName: Rate Plan 1
subscriptionId: 402880e47ccbaca1017ccbdd644d18d0
subscriptionVersion: 5
success: true
schema:
$ref: '#/components/schemas/GetOrderActionRatePlanResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a rate plan
tags:
- Rate Plans
/v1/omni-channel-subscriptions:
post:
description: |
Creates or updates an omnichannel subscription for a customer account.
You can also create a new customer account and assign it to the new omnichannel subscription.
operationId: postOmnichannelSubscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/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/CreateOmniChannelSubscriptionRequest'
required: true
responses:
'200':
content:
application/json:
example:
success: true
subscriptionId: 54be52bbb1b9288bbf82942e00de0000
subscriptionNumber: A-S00000001
accountId: 2c98906e9288bc0b0192942dfbdc316d
accountNumber: AN_1729062894303
schema:
$ref: '#/components/schemas/CreateOmniChannelSubscriptionResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
4XX:
content:
application/json:
example:
processId: processId
reasons:
- code: '51001122'
message: '''billToContact'' may not be null'
- code: '51000030'
message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Invalid input
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
summary: Create an omnichannel subscription
tags:
- Omnichannel Subscriptions
/v1/omni-channel-subscriptions/{subscriptionKey}:
get:
description: 'Retrieves the information about a specific omnichannel subscription. '
operationId: getOmnichannelSubscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_REQUEST_get_account_details'
- description: The ID or number of the omnichannel subscription to be retrieved. The ID may be a Zuora subscription ID or an external system subscription ID.
in: path
name: subscriptionKey
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
success: true
id: 303d186840e611df817c002185d714e1
subscriptionNumber: A-S00000001
externalSubscriptionId: 56cc93ed3767476782cf2f150e38249c
accountId: 2c98906e9288bc0b0192942dfbdc316d
externalTransactionReason: Purchase
externalSourceSystem: Apple
externalState: Grace
state: Active
externalProductId: 874d2a0ef3ad43d5b3402771f56aca1d
externalReplaceByProductId: null
externalInAppOwnershipType: Purchase
externalQuantity: 1
currency: USD
autoRenew: false
originalPurchaseDate: '2024-02-01 00:01:15'
externalPurchaseDate: '2024-03-05 10:42:11'
externalActivationDate: '2024-03-01 12:12:12'
externalExpirationDate: '2024-06-01 12:12:12'
externalApplicationId: external-application-id
externalBundleId: external-bundle-id
externalSubscriberId: external-subscriber-id
externalPrice: 100
externalPurchaseType: Purchase
externalLastRenewalDate: '2024-03-01 12:12:12'
externalNextRenewalDate: '2024-09-01 12:12:12'
schema:
$ref: '#/components/schemas/GetOmniChannelSubscriptionResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. '
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. '
schema:
maxLength: 64
type: string
4XX:
content:
application/json:
example:
processId: processId
reasons:
- code: '51001122'
message: '''billToContact'' may not be null'
- code: '51000030'
message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Invalid input
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. '
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. '
schema:
maxLength: 64
type: string
summary: Retrieve an omnichannel subscription
tags:
- Omnichannel Subscriptions
delete:
description: 'Deletes a specified omnichannel subscription. '
operationId: deleteOmnichannelSubscription
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The key of the omnichannel subscription to be deleted.
in: path
name: subscriptionKey
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
success: true
schema:
$ref: '#/components/schemas/CommonResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
4XX:
content:
application/json:
example:
processId: processId
reasons:
- code: '51001122'
message: '''billToContact'' may not be null'
- code: '51000030'
message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Invalid input
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Delete an omnichannel subscription
tags:
- Omnichannel Subscriptions
/v1/subscription-change-logs/{subscriptionNumber}:
get:
description: |
Lists subscription change histories of a single version subscription. Each history maps to an order.
See the `subscriptions` > `fields`, `ratePlans` > `fields`, and `ratePlanCharges` > `fields` fields for the changes in the subscription, subscription rate plans, and subscription rate plan charges.
**Note**: This operation is only available if you have the following features turned on:
- Orders
- Single Version Subscription
operationId: getSubscriptionChangeLogsBySubscriptionNumber
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The subscription number to be retrieved.
in: path
name: subscriptionNumber
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
success: true
subscriptions:
- subscriptionNumber: A-S00000001
version: 2
subscriptionStartDate: '2021-01-01'
subscriptionEndDate: '2023-02-01'
termStartDate: '2021-02-01'
termEndDate: '2023-02-01'
accountNumber: AN_1723454733315
invoiceOwnerAccountNumber: AN_1723454733315
currency: USD
orderNumber: O-00000002
type: Standard
externalSubscriptionId: null
changedTime: '2024-08-12 02:25:36'
ratePlans:
- ratePlanNumber: SRP-00000001
ratePlanCharges:
- chargeNumber: C-00000001
ratePlanChargeId: 28b907304229145dff3145e84432000a
effectiveStartDate: '2021-01-01'
effectiveEndDate: '2023-02-01'
fields:
- fieldName: effectiveEndDate
oldValue: '2022-01-01'
newValue: '2023-02-01'
fields: []
fields:
- fieldName: initialTerm
oldValue: '12'
newValue: '2'
- fieldName: initialTermPeriodType
oldValue: Month
newValue: Year
- subscriptionNumber: A-S00000001
version: 1
subscriptionStartDate: '2021-01-01'
subscriptionEndDate: '2022-01-01'
termStartDate: '2021-01-01'
termEndDate: '2022-01-01'
accountNumber: AN_1723454733315
invoiceOwnerAccountNumber: AN_1723454733315
currency: USD
orderNumber: O-00000001
type: Standard
externalSubscriptionId: null
changedTime: '2024-08-12 02:25:35'
ratePlans:
- ratePlanNumber: SRP-00000001
ratePlanCharges:
- chargeNumber: C-00000001
ratePlanChargeId: 28b907304229145dff3145e84432000a
effectiveStartDate: '2021-01-01'
effectiveEndDate: '2022-01-01'
fields:
- fieldName: price
oldValue: null
newValue: '100'
- fieldName: quantity
oldValue: null
newValue: '1'
fields:
- fieldName: RP_CF1__c
oldValue: null
newValue: Init value for rp cf 1
fields:
- fieldName: accountId
oldValue: null
newValue: ff8080819145e003019145e83c4657cb
- fieldName: autoRenew
oldValue: null
newValue: 'false'
schema:
$ref: '#/components/schemas/GetSubscriptionChangeLogsResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. '
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. '
schema:
maxLength: 64
type: string
4XX:
content:
application/json:
example:
processId: processId
reasons:
- code: '51001122'
message: '''billToContact'' may not be null'
- code: '51000030'
message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Invalid input
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List change histories of a subscription
tags:
- Subscription Change History
/v1/subscription-change-logs/orders/{orderNumber}:
get:
description: |
List the change histories of single version subscriptions that are included in and processed by an order. Each history maps to a subscription associated with this order.
See the `subscriptions` > `fields`, `ratePlans` > `fields`, and `ratePlanCharges` > `fields` fields for the changes in the subscription, subscription rate plans, and subscription rate plan charges.
**Note**: This operation is only available if you have the following features turned on:
- Orders
- Single Version Subscription
operationId: getSubscriptionChangeLogsByOrderNumber
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The order number associated with the subscription to be retrieved.
in: path
name: orderNumber
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
success: true
subscriptions:
- subscriptionNumber: A-S00000001
version: 1
subscriptionStartDate: '2021-01-01'
subscriptionEndDate: '2022-01-01'
termStartDate: '2021-01-01'
termEndDate: '2022-01-01'
accountNumber: AN_1723456739867
invoiceOwnerAccountNumber: AN_1723456739867
currency: USD
orderNumber: O-00000001
type: Standard
externalSubscriptionId: null
changedTime: '2024-08-12 02:59:00'
ratePlans:
- ratePlanNumber: SRP-00000001
ratePlanCharges:
- chargeNumber: C-00000001
ratePlanChargeId: 240207304399145dff314606db890009
effectiveStartDate: '2021-01-01'
effectiveEndDate: '2022-01-01'
fields:
- fieldName: price
oldValue: null
newValue: '100'
- fieldName: quantity
oldValue: null
newValue: '1'
fields: []
fields:
- fieldName: accountId
oldValue: null
newValue: ff8080819145e00301914606da4c613f
- fieldName: autoRenew
oldValue: null
newValue: 'false'
- subscriptionNumber: A-S00000002
version: 1
subscriptionStartDate: '2021-01-01'
subscriptionEndDate: '2023-01-01'
termStartDate: '2021-01-01'
termEndDate: '2023-01-01'
accountNumber: AN_1723456739867
invoiceOwnerAccountNumber: AN_1723456739867
currency: USD
orderNumber: O-00000001
type: Standard
externalSubscriptionId: null
changedTime: '2024-08-12 02:59:00'
ratePlans:
- ratePlanNumber: SRP-00000002
ratePlanCharges:
- chargeNumber: C-00000002
ratePlanChargeId: 240207304399145dff314606dbe50014
effectiveStartDate: '2021-01-01'
effectiveEndDate: '2023-01-01'
fields:
- fieldName: price
oldValue: null
newValue: '400'
- fieldName: quantity
oldValue: null
newValue: '1'
fields: []
fields:
- fieldName: accountId
oldValue: null
newValue: ff8080819145e00301914606da4c613f
- fieldName: autoRenew
oldValue: null
newValue: 'false'
schema:
$ref: '#/components/schemas/GetSubscriptionChangeLogsResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. '
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. '
schema:
maxLength: 64
type: string
4XX:
content:
application/json:
example:
processId: processId
reasons:
- code: '51001122'
message: '''billToContact'' may not be null'
- code: '51000030'
message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Invalid input
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: List change histories of subscriptions by order number
tags:
- Subscription Change History
/v1/subscription-change-logs/{subscriptionNumber}/versions/{version}:
get:
description: |
Retrieves the change history of a single version subscription by version. This version indicates the creation sequence of the orders associated with the subscription and starts from `1`.
See the `subscription` > `fields`, `ratePlans` > `fields`, and `ratePlanCharges` > `fields` fields for the changes in the subscription, subscription rate plans, and subscription rate plan charges.
**Note**: This operation is only available if you have the following features turned on:
- Orders
- Single Version Subscription
operationId: getSubscriptionChangelogByVersion
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- description: The subscription number to be retrieved.
in: path
name: subscriptionNumber
required: true
schema:
type: string
- description: |
This version indicates the creation sequence of the orders associated with the subscription and starts from `1`.
in: path
name: version
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
success: true
subscription:
subscriptionNumber: A-S00000001
version: 2
subscriptionStartDate: '2021-01-01'
subscriptionEndDate: '2023-02-01'
termStartDate: '2021-02-01'
termEndDate: '2023-02-01'
accountNumber: AN_1723454733315
invoiceOwnerAccountNumber: AN_1723454733315
currency: USD
orderNumber: O-00000002
type: Standard
externalSubscriptionId: null
changedTime: '2024-08-12 02:25:36'
ratePlans:
- ratePlanNumber: SRP-00000001
ratePlanCharges:
- chargeNumber: C-00000001
ratePlanChargeId: 28b907304229145dff3145e84432000a
effectiveStartDate: '2021-01-01'
effectiveEndDate: '2023-02-01'
fields:
- fieldName: effectiveEndDate
oldValue: '2022-01-01'
newValue: '2023-02-01'
fields: []
fields:
- fieldName: initialTerm
oldValue: '12'
newValue: '2'
- fieldName: initialTermPeriodType
oldValue: Month
newValue: Year
schema:
$ref: '#/components/schemas/GetSubscriptionChangeLogResponse'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. '
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. '
schema:
maxLength: 64
type: string
4XX:
content:
application/json:
example:
processId: processId
reasons:
- code: '51001122'
message: '''billToContact'' may not be null'
- code: '51000030'
message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Invalid input
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Retrieve a change history of a subscription by version
tags:
- Subscription Change History
/v1/ppdd/reverse-rollover:
post:
description: |
This REST API reference describes how to manually reverse fund rollover from source validity period to destination validity period. There are no path or query parameters.
**Note**: This API will not work if the associated prepayment charge has rollover enabled.
operationId: POST_ReverseRollover
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTReverseRolloverRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
message: Reverse rollover is done
reverseRolloverFundCount: 1
success: true
schema:
$ref: '#/components/schemas/POSTReverseRolloverResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Reverse fund rollover
tags:
- Prepaid with Drawdown
/v1/ppdd/rollover:
post:
description: |
Prepaid with Drawdown Rollover enables you to transfer the accumulative carryover of your customers’ prepaid balance funds to the following validity period when using Prepaid with Drawdown. This REST API reference describes how to manually trigger fund rollover from source validity period to destination validity period. There are no path or query parameters.
**Note**: This API will not work if rollover is enabled in the associated prepayment charge. If you want to trigger rollover automatically, see Create prepayment charge with rollover for more information.
operationId: POST_Rollover
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTTriggerRolloverRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
message: Rollover is done
rolloverFundCount: 1
success: true
schema:
$ref: '#/components/schemas/POSTTriggerRolloverResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Trigger fund rollover
tags:
- Prepaid with Drawdown
/v1/prepaid-balance-funds/deplete:
post:
description: 'Depleting a prepaid balance fund enables you to expire the remaining balance, which can be recognized by revenue. When an expiry request is received, the remaining fund balance is reduced to zero, and the related objects like PrepaidBalance, ValidityPeriodSummary, PrepaidBalanceTransaction, and DailyConsumption will be updated. '
operationId: DepleteFunds
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POSTDepleteFundRequestType'
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
fundIds:
- fundId: 4028818c8d3ade79018d3ae1048a5e10
status: success
message: The fund object is depleted.
- fundId: 4028818c8d3ade79018d3ae1048a5ef8
status: success
message: The fund object is depleted.
schema:
$ref: '#/components/schemas/POSTDepleteFundResponseType'
description: OK
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: |
The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: string
RateLimit-Remaining:
description: |
The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
RateLimit-Reset:
description: |
The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.
schema:
type: number
Zuora-Request-Id:
description: |
The Zuora internal identifier of the API call. You cannot control the value of this header.
schema:
maxLength: 36
minLength: 36
type: string
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
Concurrency-Limit-Type:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type'
Concurrency-Limit-Limit:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit'
Concurrency-Limit-Remaining:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining'
'500':
content:
application/json:
examples:
response:
value:
reasons:
- code: SystemError
message: internal server error
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Internal Server Error
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
4XX:
content:
application/json:
examples:
response:
value:
processId: 738CBB9234B47A47
reasons:
- code: '58730222'
message: orderDate may not be null
requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
success: false
schema:
$ref: '#/components/schemas/CommonResponse'
description: Request Errors
headers:
Content-Encoding:
description: |
This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.
Note that only the following MIME types support gzipped responses:
- `application/json`
- `application/xml`
- `text/html`
- `text/csv`
- `text/plain`
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. '
schema:
type: number
Zuora-Request-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
Zuora-Track-Id:
$ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
summary: Deplete funds
tags:
- Prepaid with Drawdown
/v1/usage:
post:
description: |
This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. There are no path or query parameters. The data is uploaded using the HTTP multipart/form-data POST method and applied to the user's tenant.
### How this REST API Call Works
The content of the uploaded usage file must follow the format used by the UI import tool. It must be a comma-separated (CSV) file with a corresponding .csv extension. The length of the file name must not exceed 50 characters. The file size must not exceed 4MB. See [Downloading the Usage Template](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/Usage/C_Import_Usage_Data#Downloading_the_Usage_Template) to learn about how to download the usage file template.
At the completion of the upload, before the file contents are actually being processed, the API returns a response containing the byte count of the received file and a URL for checking the status of the import process. Of the five possible results displayed at that URL (Pending, Processing, Completed, Canceled, and Failed) only a Completed status indicates that the import was successful. The operation is atomic; if any record fails, the file is rejected. In that case, the entire import is rolled back and all stored data is returned to its original state.
To view the actual import status, enter the resulting status URL from the checkImportStatus response using a tool such as POSTMAN. This additional step provides more information about why the import has failed.
To manage the information after a successful upload, use the web-based UI.
### Usage File Format
The usage file uses the following headings:
| Heading | Description | Required |
|-----------------|--------|----------|
| ACCOUNT_ID | Enter the account number, e.g., the default account number, such as A00000001, or your custom account number. Although this field is labeled as Account_Id, it is not the actual Account ID nor Account Name. | Yes |
| UOM | Enter the unit of measure. This must match the UOM for the usage. | Yes |
| QTY | Enter the quantity. | Yes |
| STARTDATE | Enter the start date of the usage. This date determines the invoice item service period the associated usage is billed to. Date format is based on locale of the current user. Default date format: `MM/DD/YYYY`. | Yes |
| ENDDATE | Enter the end date of the usage. This is not used in calculations for usage billing and is optional. Date format is based on locale of the current user. Default date format: `MM/DD/YYYY`. **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_Authorization_OAuth_optional' - $ref: '#/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: 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/usage/accounts/{account-key}: get: description: | This REST API reference describes how to retrieve usage details for an account. Usage data is returned in reverse chronological order. operationId: GET_Usage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: Account number or account ID. in: path name: account-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true usage: - CheckType__c: null City__c: null ClockTiime__c: null Colour__c: null Meter__c: null Size__c: null Timeofday__c: null accountId: 8ad096ca865969c801865ccbfcb77adf accountName: Song accountNumber: A00000113 chargeNumber: null fileName: UsageFileFormat-178.csv id: 8ad098f08659582c01865cd2a40057a5 network__c: null quantity: 100 rate__c: null sourceName: Import startDateTime: '2023-01-15 00:00:00' state__c: null status: Pending submissionDateTime: '2023-02-16 16:42:32' subscriptionNumber: A-S00000224 timeOfUse__c: Off-Peak totalAmount__c: null uniqueKey: '123' unitOfMeasure: Ads schema: $ref: '#/components/schemas/GETUsageWrapper' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: 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 usage record tags: - 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_HEADER_Authorization_OAuth_optional' - $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' 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_Authorization_OAuth_optional' - $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 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_Authorization_OAuth_optional' - $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 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_HEADER_Authorization_OAuth_optional' - $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 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 /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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/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/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_Authorization_OAuth_optional' - $ref: '#/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/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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 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_Authorization_OAuth_optional' - $ref: '#/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/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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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 "Create Standalone Invoice" and "Modify Invoice" user permissions. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. As of Zuora Release 2022.03.R5, newly created standard Billing users have the “Create Standalone Invoice” permission enabled by default. 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_Authorization_OAuth_optional' - $ref: '#/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/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_Authorization_OAuth_optional' - $ref: '#/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/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 "Create Standalone Invoice" and "Modify Invoice" user permissions. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. As of Zuora Release 2022.03.R5, newly created standard Billing users have the “Create Standalone Invoice” permission enabled by default. ### 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_Authorization_OAuth_optional' - $ref: '#/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/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. 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_Authorization_OAuth_optional' - $ref: '#/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/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_Authorization_OAuth_optional' - $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 - description: |2 The minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. in: header name: zuora-version required: false schema: type: string 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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}/einvoice/generate: put: description: | Generates an e-invoice file for an invoice. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_GenerationEInvoiceGenerationForInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $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 responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate an e-invoice file for an invoice tags: - 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 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. 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_Authorization_OAuth_optional' - $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 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 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: '' 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: '' 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 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. **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 2,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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 `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 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_Authorization_OAuth_optional' - $ref: '#/components/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 minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string 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: false 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_Authorization_OAuth_optional' - $ref: '#/components/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 minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string 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_Authorization_OAuth_optional' - $ref: '#/components/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 minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string 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_Authorization_OAuth_optional' - $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 - description: |2 The minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. in: header name: zuora-version required: false schema: type: string 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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: false 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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}/e-invoice/generate: put: description: | Generates an e-invoice file for a credit memo. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_GenerateEInvoiceFileForCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM-0000001. in: path name: creditMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate an e-invoice file for a credit memo tags: - 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $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 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - 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: '' 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: '' 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_Authorization_OAuth_optional' - $ref: '#/components/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 - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string responses: '200': content: application/json: examples: response: value: amount: 1 amountWithoutTax: 1 appliedAmount: 0 appliedToItemId: null comment: '' 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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: false 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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: 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-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_Authorization_OAuth_optional' - $ref: '#/components/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 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: false excludeFromAutoApplyRules: false autoApplyUponPosting: false reversed: false taxStatus: null sourceType: Invoice eInvoiceStatus: Failed eInvoiceErrorCode: IntegrationError eInvoiceErrorMessage: Input string was null. eInvoiceFileId: null taxMessage: null billToContactId: null billToContactSnapshotId: 8a90b4488e7d5c0f018e7dbef1f900c9 sequenceSetId: null invoiceGroupNumber: null revenueImpacting: true 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - 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/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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 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_Authorization_OAuth_optional' - $ref: '#/components/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 minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string 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: false 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_Authorization_OAuth_optional' - $ref: '#/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/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_Authorization_OAuth_optional' - $ref: '#/components/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 minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string 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_Authorization_OAuth_optional' - $ref: '#/components/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 minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string 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_Authorization_OAuth_optional' - $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 - description: |2 The minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. in: header name: zuora-version required: false schema: type: string 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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}/e-invoice/generate: put: description: | Generates an e-invoice file for a debit memo. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_GenerateEInvoiceFileForDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the debit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or DM-0000001. in: path name: debitMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate an e-invoice file for a debit memo tags: - 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $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 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_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 - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - 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_Authorization_OAuth_optional' - $ref: '#/components/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 - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' 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_Authorization_OAuth_optional' - $ref: '#/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/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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 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_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' responses: '200': content: application/json: examples: response: value: regions: - addressLine1: '' addressLine2: '' businessName: legal business name businessNumber: '20002039' businessNumberSchemaId: '88' businessRegionNumber: EIBR-00000008 city: Tokyo contactName: '' country: JP digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: '' endpointId: '8992' endpointSchemeId: '88' phoneNumber: '' postalCode: '368779' responseMapping: {} serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: '' taxRegisterNumber: TAX393999 tradeName: Zuora - addressLine1: '' addressLine2: '' businessName: legal business name businessNumber: '20002039' businessNumberSchemaId: '88' businessRegionNumber: EIBR-00000006 city: Paris contactName: '' country: FR digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: '' endpointId: '8992' endpointSchemeId: '88' phoneNumber: '' postalCode: '368779' responseMapping: {} serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: '' taxRegisterNumber: TAX393999 tradeName: Zuora 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_Authorization_OAuth_optional' - $ref: '#/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/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 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_Authorization_OAuth_optional' - $ref: '#/components/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 responses: '200': content: application/json: examples: response: value: addressLine1: '' addressLine2: '' businessName: legal business name businessNumber: '20002039' businessNumberSchemeId: '88' businessRegionNumber: EIBR-00000002 city: Rome contactName: '' country: IT digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: '' endpointId: '8992' endpointSchemeId: '88' id: 8a90f508885201ad018856a2d9070163 phoneNumber: '' postalCode: '368779' responseMapping: {} serviceProviderId: 8a90876c8851d877018855e81a6b710d state: '' success: true taxRegisterNumber: TAX393999 tradeName: Zuora 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_Authorization_OAuth_optional' - $ref: '#/components/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 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 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/einvoice/templates: get: description: | Lists information about e-invoice file templates. You can query e-invoice file templates by conditions. For example, if your service provider is Sovos, you can use the following example URL to retrieve information about a list of e-invoice file templates for invoices in India: `/v1/einvoice/templates?country=IN&documentType=Invoice&provider=Sovos` **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoiceFileTemplates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The short name of a country or region where you must comply with e-invoicing requirements. For example, `IN` for India. For the full list of country names and codes, see View countries or regions. in: query name: country required: true schema: type: string - description: | The type of billing documents for which the e-invoice file template is intended. in: query name: documentType required: true schema: enum: - Invoice - CreditMemo - DebitMemo type: string - description: | The name of the e-invoicing service provider that assists in generating e-invoice files. in: query name: provider required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true templates: - country: SA documentType: Invoice id: 402833ec89d46b390189d51402d937b0 name: EInvoice Template Name provider: Sovos templateNumber: EITEMP-00000006 - country: SA documentType: CreditMemo id: 402833ec89d46b390189d514030537b2 name: EInvoice Template Name provider: Sovos templateNumber: EITEMP-00000008 - country: SA documentType: DebitMemo id: 402833ec89d46b390189d514032037b4 name: EInvoice Template Name provider: Sovos templateNumber: EITEMP-00000009 schema: $ref: '#/components/schemas/ListEInvoiceFileTemplatesResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List e-invoice file templates tags: - E-Invoicing post: description: | Creates an e-invoice file templates for your billing documents, including invoices, credit memos, and debit memos. Zuora provides default e-invoice file templates, so you can just customize them as needed. For example, some country specific fields like HSN (Harmonized System of Nomenclature) might be stored on product rate plan charges. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: POST_CreateEInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/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/CreateEInvoiceFileTemplateRequest' required: true responses: '200': content: application/json: examples: response: value: content: base64 encoded content country: IN documentType: Invoice id: 4028818484f483d20184f5006b97003f name: Sovos e-invoice service provider: Sovos success: true templateNumber: EITEMP-00000003 schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an e-invoice file template tags: - E-Invoicing /v1/einvoice/templates/{key}: delete: description: | Deletes an e-invoice file template by key. The key can be the unique ID or number of an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: DELETE_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoice file template that you want to delete. in: path name: key required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an e-invoice file template tags: - E-Invoicing get: description: | Retrieves information about an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the e-invoice file template that you want to retrieve information about. in: path name: key required: true schema: type: string responses: '200': content: application/json: examples: response: value: content: base64 encoded content country: IN documentType: Invoice id: 4028818484f483d20184f5006b97003f name: Sovos e-invoice service provider: Sovos success: true templateNumber: EITEMP-00000003 schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an e-invoice file template tags: - E-Invoicing put: description: | Updates information about an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the e-invoice file template that you want to update. in: path name: key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoiceFileTemplateRequest' required: true responses: '200': content: application/json: examples: response: value: content: base64 encoded content country: IN documentType: Invoice id: 4028818484f483d20184f5006b97003f name: Sovos e-invoice service provider: Sovos success: true templateNumber: EITEMP-00000003 schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an e-invoice file template tags: - E-Invoicing /v1/invoice-schedules: post: description: | Creates an invoice schedule. ### Limitations This API operation has the following limitations: * You can create at most 50 invoice schedule items in one request. * You can associate at most 10 orders with an invoice schedule in one request. * You can associate at most 300 subscriptions with an invoice schedule in one request, including those contained in orders and separate subscriptions. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: POST_CreateInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/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/POSTCreateInvoiceScheduleRequest' required: true responses: '200': content: application/json: examples: response: value: actualAmount: 70200 additionalSubscriptionsToBill: - S-00000001 - S-00000002 billedAmount: 0 currency: USD id: e2441b3e24eb42859194be7da2403b38 invoiceSeparately: false nextRunDate: '2022-02-24' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 50000 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 percentage: null runDate: '2022-02-24' status: Pending targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: Pending success: true totalAmount: 70200 unbilledAmount: 70200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}: delete: description: | Deletes an invoice schedule in Pending status. The status of the invoice schedule to be deleted must be `Pending`. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: DELETE_InvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the invoice schedule to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an invoice schedule tags: - Invoice Schedules get: description: | Retrieves detailed information about an invoice schedule. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: GET_InvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of the invoice schedule to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: actualAmount: 20200 additionalSubscriptionsToBill: - S-00000001 - S-00000002 billedAmount: 50000 currency: USD id: e2441b3e24eb42859194be7da2403b38 invoiceSeparately: false nextRunDate: '2022-10-17' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 0 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 invoiceId: 8a8881aa82118bec018211dafc1e1695 percentage: null runDate: '2022-02-24' status: Processed targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: PartiallyProcessed success: true totalAmount: 70200 unbilledAmount: 20200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an invoice schedule tags: - Invoice Schedules put: description: | Updates a pending invoice schedule. You can use this API operation to update invoice schedules in the following aspects: - Update notes and pending invoice schedule items - Update orders associated with invoice schedules - Remove or add invoice schedule items For more samples, see Edit invoice schedules ### Restrictions and limitations When updating invoice schedules through the REST API, keep the following restrictions and limitations in mind: - You can only update invoice schedule items in `Pending` status. - You can only add orders or specific subscriptions to pending invoice schedules, and remove orders or specific subscriptions from pending invoice schedules. - For the invoice schedule items that you want to update, you must include the new values for these items in the request. - For the invoice schedule items that you want to keep unchanged, you must include all the existing information about these items in the request. Otherwise, the existing invoice schedule items that you do not include in the request are deleted. - For the orders that you want to keep unchanged for an invoice schedule, you must include all the existing order numbers associated with the invoice schedule in the request. Otherwise, the existing orders that you do not include in the request are removed. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: PUT_UpdateInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the invoice schedule to be updated. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTUpdateInvoiceScheduleRequest' required: true responses: '200': content: application/json: examples: response: value: actualAmount: 70200 additionalSubscriptionsToBill: - S-00000001 - S-00000002 billedAmount: 0 currency: USD id: e2441b3e24eb42859194be7da2403b38 invoiceSeparately: false nextRunDate: '2022-02-24' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 54000 amount: 54000 id: 8a8881aa82118bec018211daf9f01680 percentage: null runDate: '2022-02-24' status: Pending targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 10000 amount: 10000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: Pending success: true totalAmount: 70200 unbilledAmount: 70200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/execute: post: description: | Executes an invoice schedule immediately. During the execution, a bill run is created and generates an invoice or a credit memo asynchronously. When you use this API operation to execute an invoice schedule item, you have the flexibility to decide whether to specify a specific item ID. - If you specify the unique ID of an invoice schedule item to be executed in the request, the corresponding invoice schedule item is executed. - If you do not specify the ID of any invoice schedule item in the request, the subscription end date is used as the target date to determine the next pending schedule item to be executed. A paused invoice schedule and charges inside cannot be automatically executed by Zuora Scheduler or by this "Execute an invoice schedule" API operation. In this case, you can do one of the following: - Use the Generate billing documents by account ID API operation - Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API For more samples, see [Execute invoice schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_tutorials/Execute_invoice_schedules). **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: POST_ExecuteInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTExecuteInvoiceScheduleRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExecuteInvoiceScheduleBillRunResponse' autoEmail: examples: response: value: false autoPost: examples: response: value: false autoRenewal: examples: response: value: false billRunFilters: examples: response: value: - accountId: 8ad09c4b82b5c6330182c5ccab3570e6 filterType: InvoiceSchedule billRunNumber: examples: response: value: BR-00001017 createdById: examples: response: value: 2c92c0f84298ac5901429dea196212be createdDate: examples: response: value: '2022-08-22 06:47:18' id: examples: response: value: 8ad0823f82b5b2520182c5cec5fe40fb invoiceDate: examples: response: value: '2022-02-24' noEmailForZeroAmountInvoice: examples: response: value: false status: examples: response: value: Pending success: examples: response: value: true targetDate: examples: response: value: '2022-02-24' updatedById: examples: response: value: 2c92c0f84298ac5901429dea196212be updatedDate: examples: response: value: '2022-08-22 06:47:18' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Execute an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/pause: put: description: | Pauses an invoice schedule immediately. A paused invoice schedule and charges inside cannot be automatically executed by Zuora Scheduler or by the Execute an invoice schedule API operation. In this case, you can do one of the following: - Use the Generate billing documents by account ID API operation - Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: PUT_PauseInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: actualAmount: 20200 billedAmount: 50000 currency: USD id: e2441b3e24eb42859194be7da2403b38 nextRunDate: '2022-10-17' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 0 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 invoiceId: 8a8881aa82118bec018211dafc1e1695 percentage: null runDate: '2022-02-24' status: Processed targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: Paused success: true totalAmount: 70200 unbilledAmount: 20200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Pause an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/resume: put: description: | Resumes an invoice schedule in Paused status immediately. After an invoice schedule is resumed, it can continue to be automatically executed by Zuora Scheduler or by the [Execute an invoice schedule](https://developer.zuora.com/api-references/api/operation/POST_ExecuteInvoiceSchedule/) API operation. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: PUT_ResumeInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the schedule to be resumed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: actualAmount: 20200 billedAmount: 50000 currency: USD id: e2441b3e24eb42859194be7da2403b38 nextRunDate: '2022-10-17' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 0 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 invoiceId: 8a8881aa82118bec018211dafc1e1695 percentage: null runDate: '2022-02-24' status: Processed targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: PartiallyProcessed success: true totalAmount: 70200 unbilledAmount: 20200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Resume an invoice schedule tags: - Invoice Schedules /v1/object/taxation-item: post: description: Creates a Taxation Item object. operationId: Object_POSTTaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $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' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateTaxationItem' required: true responses: '200': content: application/json: examples: response: value: Id: 2c93808457d787030157e0306f413a96 Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: examples: response: value: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Create a taxation item' tags: - Taxation Items /v1/taxation-items/{id}: delete: description: | Deletes a specific taxation item by ID. operationId: DELETE_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a taxation item. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a taxation item tags: - Taxation Items get: description: | Retrieves the information about a specific taxation item by ID. operationId: GET_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a taxation item. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-02-27 11:52:03' exemptAmount: 0 financeInformation: onAccountAccountingCode: Check onAccountAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a7d4022015a7db254e200c8 jurisdiction: null locationCode: null memoItemId: 402890555a7d4022015a7db254d800c7 name: my tax sourceTaxItemId: 402890555a7d4022015a7db254e200c1 success: true taxAmount: 1 taxCode: ZtaxCode taxCodeDescription: '' taxDate: '2017-02-27' taxRate: 5 taxRateDescription: null taxRateType: FlatFee updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-02-27 11:52:03' schema: $ref: '#/components/schemas/GETTaxationItemType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: | Retrieve a taxation item tags: - Taxation Items put: description: | Updates a specific taxation item by ID. operationId: PUT_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a taxation item. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTTaxationItemType' required: true responses: '200': content: application/json: examples: response: value: createdById: 8ad084a67f9c7138017fab8a8b511b5a createdDate: '2024-11-04 10:53:16' exemptAmount: 0 id: 8ad09d9392e0a4430192f51746d121f6 memoItemId: null invoiceItemId: 8ad086fa92d66ffe0192dc7e5dd65161 sourceTaxItemId: null jurisdiction: CALIFORNIA locationCode: null name: CA TAX taxAmount: 3 applicableTaxUnRounded: 3 country: null taxCode: null taxCodeDescription: null taxDate: '2024-11-04' taxRate: 3 taxMode: TaxExclusive taxRateDescription: Details of the tax rate taxRateType: FlatFee updatedById: 8ad084a67f9c7138017fab8a8b511b5a updatedDate: '2024-11-04 10:57:51' financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null salesTaxPayableAccountingCode: Sales Tax Payable salesTaxPayableAccountingCodeType: SalesTaxPayable success: true schema: $ref: '#/components/schemas/GETTaxationItemType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a taxation item tags: - Taxation Items /v1/sequence-sets: get: description: | Retrieves information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. You can use query parameters to restrict the data returned in the response. **Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: GET_SequenceSets parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The name or number of a specific sequence set. in: query name: name required: false schema: type: string responses: '200': content: application/json: examples: response: value: sequenceSets: - creditMemo: prefix: CM startNumber: 11 debitMemo: prefix: DM startNumber: 12 id: 2c98906c69be199c0169be74ed210afd invoice: prefix: INV startNumber: 10 name: DEFAULT payment: prefix: P- startNumber: 13 refund: prefix: R- startNumber: 14 - creditMemo: prefix: FCM startNumber: 11 debitMemo: prefix: FDM startNumber: 12 id: 2c98906c69be199c0169be74ed211afd invoice: prefix: FINV startNumber: 10 name: FR payment: prefix: FP- startNumber: 13 refund: prefix: FR- startNumber: 14 - creditMemo: prefix: ITACM startNumber: 11 debitMemo: prefix: ITADM startNumber: 12 id: 2c98906c69be199c0169be74ed212afd invoice: prefix: ITAINV startNumber: 10 name: ITA payment: prefix: ITAP- startNumber: 13 refund: prefix: ITAR- startNumber: 14 success: true schema: $ref: '#/components/schemas/GETSequenceSetsResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List sequence sets tags: - Sequence Sets post: description: | Creates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. You can create a maximum of 100 sequence sets in one single request. A sequence set comprises a set of custom prefixes and starting numbers that are used for billing documents to generate, and payments and refunds to create. See [Prefix and Numbering Configuration for Billing Documents](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Prefix_and_Numbering_Configuration_for_Billing_Documents) for more information about limitations. **Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: POST_SequenceSets parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSequenceSetsRequest' required: true responses: '200': content: application/json: examples: response: value: sequenceSets: - id: 402892c74c9193cd014c96bbe7c101f9 name: FR creditMemo: prefix: FCM startNumber: 10 debitMemo: prefix: FDM startNumber: 10 invoice: prefix: FINV startNumber: 10 payment: prefix: FP- startNumber: 10 refund: prefix: FR- startNumber: 10 success: true schema: $ref: '#/components/schemas/POSTSequenceSetsResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create sequence sets tags: - Sequence Sets /v1/sequence-sets/{id}: delete: description: | Deletes a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. **Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: DELETE_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the sequence set to delete. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a sequence set tags: - Sequence Sets get: description: | Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos **Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: GET_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the sequence set to retrieve information about. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: creditMemo: prefix: FCM startNumber: 11 debitMemo: prefix: FDM startNumber: 12 invoice: prefix: FINV startNumber: 10 name: FR payment: prefix: FP- startNumber: 13 refund: prefix: FR- startNumber: 14 success: true schema: $ref: '#/components/schemas/GETSequenceSetResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a sequence set tags: - Sequence Sets put: description: | Updates a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. **Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: PUT_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the sequence set to update. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSequenceSetRequest' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/PUTSequenceSetResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a sequence set tags: - Sequence Sets /v1/operations/billing-preview: post: description: | Generates a preview of future invoice items for one customer account. Use the BillingPreview call to calculate how much a single customer will be invoiced from the most recent invoice to a specific end of term date in the future. Additionally, you can use the BillingPreview service to access real-time data on an individual customer's usage consumption. The BillingPreview call only calculates taxes for charges in the subscription if you use [Zuora Tax](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax) and the product rate plan charge associated with the invoice item uses the [tax inclusive mode](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax/D_Associate_tax_codes_with_product_charges_and_set_the_tax_mode); otherwise, this call does not calculate taxes. If you have the Invoice Settlement feature enabled, you can also generate a preview of future credit memo items for one customer account. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: POST_BillingPreview parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/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/PostBillingPreviewParam' required: true responses: '200': content: application/json: examples: response: value: accountId: 8ad09bce83f1da020183f97e245c1c47 invoiceItems: - id: d573746814a14da0a0a0abda2a41d65a subscriptionName: A-S00000346 subscriptionId: 8ad08ad58e35d490018e36a0f1ca2a9c subscriptionNumber: A-S00000346 serviceStartDate: '2024-08-01' serviceEndDate: '2024-08-31' chargeAmount: 10 chargeDescription: '' chargeName: Monthly Fee chargeNumber: C-00000950 chargeId: 8ad08ad58e35d490018e36a0f2252aa5 productName: Music service quantity: 1 taxAmount: 0 unitOfMeasure: '' chargeDate: '2024-07-09 17:06:58' chargeType: Recurring processingType: Charge appliedToItemId: null numberOfDeliveries: 0 - id: c86c42ee4f5b42bd86351f4a99bf230e subscriptionName: A-S00000346 subscriptionId: 8ad08ad58e35d490018e36a0f1ca2a9c subscriptionNumber: A-S00000346 serviceStartDate: '2024-09-01' serviceEndDate: '2024-09-30' chargeAmount: 10 chargeDescription: '' chargeName: Monthly Fee chargeNumber: C-00000950 chargeId: 8ad08ad58e35d490018e36a0f2252aa5 productName: Music service quantity: 1 taxAmount: 0 unitOfMeasure: '' chargeDate: '2024-07-09 17:06:58' chargeType: Recurring processingType: Charge appliedToItemId: null numberOfDeliveries: 0 success: true schema: $ref: '#/components/schemas/BillingPreviewResult' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate a billing preview tags: - Operations /v1/operations/invoice-collect: post: description: | Generates and posts invoices and credit memos and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement feature enabled and negative charges exist. Credit memos will not be applied to invoices. If draft invoices and credit memos exist when you run this operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan charge will not be posted. You can use this operation to generate invoices and collect payments on the posted invoices, or else simply collect payment on a specified existing invoice. The customer's default payment method is used, and the full amount due is collected. The operation depends on the parameters you specify. - To generate one or more new invoices for that customer and collect payment on the generated and other unpaid invoice(s), leave the **invoiceId** field empty. - To collect payment on an existing invoice, specify the invoice ID. The operation is atomic; if any part is unsuccessful, the entire operation is rolled back. When an error occurs, gateway reason codes and error messages are returned the error response of this operation. The following items are some gateway response code examples. - Orbital: `05 Do Not Honor`; `14 Invalid Credit Card Number` - Vantiv: `301 Invalid Account Number`; `304 Lost/Stolen Card` - CyberSource2: `202 Expired card`; `231 Invalid account number` For more reason code information, see the corresponding payment gateway documentation. ### Notes Timeouts may occur when using this method on an account that has an extremely high number of subscriptions. operationId: POST_TransactionInvoicePayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/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 minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTInvoiceCollectType' required: true responses: '200': content: application/json: examples: response: value: amountCollected: 801.73 creditMemos: - id: 402890555a7e9791015a879f064a0054 totalAmount: 801.73 memoNumber: CM00000012 invoices: - invoiceAmount: 801.73 invoiceId: 4028925a4cb74ec9014cb7540988002e invoiceNumber: INV00000091 paymentId: 402892053e100406013e1024ab7c00e3 success: true schema: $ref: '#/components/schemas/POSTInvoiceCollectResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Invoice and collect tags: - Operations /v1/operations/jobs/{jobId}: get: description: | Retrieves information about a specific operation job. Currently, you can only use this API operation to retrieve the status information about invoice deletion operation jobs. operationId: GET_OperationJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID of the operation job to retrieve information about. For example, 2c92c8955bd63cc1015bd7c151af02ab. in: path name: jobId required: true schema: type: string responses: '200': content: application/json: examples: response: value: id: 4028818484a949680184a95174cb0019 objectId: 4028818484a949680184a9510c960009 objectType: Invoice operationType: Delete status: Completed success: true schema: $ref: '#/components/schemas/GetOperationJobResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an operation job tags: - Operations /v1/operations/bulk-pdf: post: description: | The background job that compresses large number of PDF(s) into ZIP files. For answers to frequently asked questions regarding exporting bulk PDF files, see Export Bulk PDF Files FAQs. operationId: Create_BulkPDFToZIPGeneration parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkPdfGenerationJobRequestType' required: true responses: '200': content: application/json: example: jobId: 402880de8ce7edc3018ce7f18404312a jobName: BulkPDFGenerationJobV1 status: Completed stepStatus: PostProcessing fileUrls: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_Authorization_OAuth' - $ref: '#/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_Authorization_OAuth' - $ref: '#/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_Authorization_OAuth_optional' - 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 - soldtoid - status - in: query name: expand[] required: false schema: type: array items: type: string enum: - billto - soldto - 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 - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 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/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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 responses: '200': content: application/json: 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' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_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_Authorization_OAuth_optional' - 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 - billtocontact - 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 responses: '200': content: application/json: schema: type: object title: QueryInvoicesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedInvoice' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/invoices/{key}: get: summary: Retrieve an invoice description: | Retrieve the details of a specific Invoice object. operationId: queryInvoiceByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - 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 - invoiceitems - invoiceitems.subscription - invoiceitems.subscription.account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedInvoice' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/invoice-items: get: summary: List invoice items description: | Lists invoice items. You can use the query parameters to filter, expand, and sort the returned results. **Note**: You must specify a `filter[]` query parameter to query invoice items. operationId: queryInvoiceItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - rateplanchargeid - invoiceid - accountingcode - chargedate - chargenumber - excludeitembillingfromrevenueaccounting - servicestartdate - sourceitemtype - subscriptionid - subscriptionnumber - productrateplanchargeid - bookingreference - in: query name: expand[] required: false schema: type: array items: type: string enum: - invoice - subscription - subscriptionowner - taxationitems - rateplancharge - orderlineitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: true schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - rateplanchargeid - invoiceid - accountingcode - chargedate - chargenumber - excludeitembillingfromrevenueaccounting - fulfillmentid - servicestartdate - sourceitemtype - subscriptionid - subscriptionnumber - productrateplanchargeid - bookingreference - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryInvoiceItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedInvoiceItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/invoice-items/{key}: get: summary: Retrieve an invoice item description: | Retrieve the details of a specific Invoice Item object. operationId: queryInvoiceItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - invoice - subscription - subscriptionowner - taxationitems - rateplancharge - orderlineitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedInvoiceItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/order-actions: get: summary: List order actions description: | Lists order actions. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryOrderActions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - subscriptionversionamendmentid - orderid - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - order description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - subscriptionversionamendmentid - orderid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryOrderActionsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedOrderAction' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/order-actions/{key}: get: summary: Retrieve an order action description: | Retrieve the details of a specific Order Action object. operationId: queryOrderActionByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - order description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedOrderAction' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/order-line-items: get: summary: List order line items description: | Lists order line items. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryOrderLineItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - itemname - itemnumber - itemstate - itemtype - orderid - productcode - productrateplanchargeid - uom - relatedsubscriptionnumber - inlinediscounttype - in: query name: expand[] required: false schema: type: array items: type: string enum: - invoiceitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - itemname - itemnumber - itemstate - itemtype - orderid - productcode - productrateplanchargeid - billtoid - soldto - owneraccountid - invoiceowneraccountid - uom - relatedsubscriptionnumber - originalorderid - originalordernumber - originalorderlineitemid - inlinediscounttype - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryOrderLineItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedOrderLineItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/order-line-items/{key}: get: summary: Retrieve an order line item description: | Retrieve the details of a specific Order Line Item object. operationId: queryOrderLineItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - invoiceitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedOrderLineItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/orders: get: summary: List orders description: | Lists orders. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryOrders parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - orderdate - ordernumber - accountid - status - invoicescheduleid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - orderlineitems - orderlineitems.invoiceitems - orderactions - orderactions.subscription - orderactions.subscription.rateplans - orderactions.subscription.rateplans.rateplancharges description: |- Allows you to expand responses by including related object information in a single call. **Note**: For draft and scheduled orders, information on the subscription, rate plan, and rate plan charges is not available nor displayed until the following conditions are met: - A scheduled order is executed and its status is changed to `completed`. - A draft order is activated and its status is changed to `pending` or `completed`. For example, if an order is in the `scheduled` or `draft` status, information on the subscription, rate plan, and rate plan charges is not displayed. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - orderdate - ordernumber - accountid - status - invoicescheduleid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryOrdersResponse description: '' nullable: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedOrders' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/orders/{key}: get: summary: Retrieve an order description: | Retrieve the details of a specific Order object. operationId: queryOrdersByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - orderlineitems - orderlineitems.invoiceitems - orderactions - orderactions.subscription - orderactions.subscription.rateplans - orderactions.subscription.rateplans.rateplancharges description: |- Allows you to expand responses by including related object information in a single call. **Note**: For draft and scheduled orders, information on the subscription, rate plan, and rate plan charges is not available nor displayed until the following conditions are met: - A scheduled order is executed and its status is changed to `completed`. - A draft order is activated and its status is changed to `pending` or `completed`. For example, if an order is in the `scheduled` or `draft` status, information on the subscription, rate plan, and rate plan charges is not displayed. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - orderdate - ordernumber - accountid - status - invoicescheduleid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedOrders' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payments: get: summary: List payments description: | Lists payments. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPayments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - amount - effectivedate - gatewayorderid - gatewaystate - paymentmethodid - paymentmethodsnapshotid - paymentnumber - referenceid - source - sourcename - status - unappliedamount - createddate - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - account.billto - account.soldto - paymentmethod - paymentapplications - paymentscheduleitempayments - paymentscheduleitempayments.paymentscheduleitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - amount - effectivedate - gatewayorderid - gatewaystate - paymentmethodid - paymentmethodsnapshotid - paymentnumber - referenceid - source - sourcename - status - unappliedamount - createddate - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryPaymentsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPayment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payments/{key}: get: summary: Retrieve a payment description: | Retrieve the details of a specific Payment object. operationId: queryPaymentByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - account.billto - account.soldto - paymentmethod - paymentapplications - paymentscheduleitempayments - paymentscheduleitempayments.paymentscheduleitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPayment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-applications: get: summary: List payment applications description: | Lists payment applications. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPaymentApplications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - effectivedate - accountid - paymentid - applicationgroupid - in: query name: expand[] required: false schema: type: array items: type: string enum: - payment description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - effectivedate - accountid - paymentid - applicationgroupid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryPaymentApplicationsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-applications/{key}: get: summary: Retrieve a payment application description: | Retrieve the details of a specific Payment Application object. operationId: queryPaymentApplicationByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - payment description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-methods: get: summary: List payment methods description: | Lists payment methods. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - achaccountname - achbankname - achcountry - active - issystem - businessidentificationcode - country - creditcardexpirationmonth - creditcardexpirationyear - creditcardmasknumber - lasttransactiondatetime - paypalbaid - type - in: query name: expand[] required: false schema: type: array items: type: string enum: - account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - achaccountname - achbankname - achcountry - active - issystem - businessidentificationcode - country - creditcardexpirationmonth - creditcardexpirationyear - creditcardmasknumber - lasttransactiondatetime - paypalbaid - type - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryPaymentMethodsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentMethod' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-methods/{key}: get: summary: Retrieve a payment method description: | Retrieve the details of a specific Payment Method object. operationId: queryPaymentMethodByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentMethod' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-method-snapshots: get: summary: List payment method snapshots description: | Lists payment method snapshots. You can use the query parameters to filter, expand, and sort the returned results. **Note**: You must specify a `filter[]` query parameter to query payment method snapshots. operationId: queryPaymentMethodSnapshots parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - country - creditcardcountry - paymentmethodid - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Method Snapshot object does not support expanding any related objects. - in: query name: filter[] required: true schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - country - creditcardcountry - paymentmethodid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryPaymentMethodSnapshotsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentMethodSnapshot' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-method-snapshots/{key}: get: summary: Retrieve a payment method snapshot description: | Retrieve the details of a specific Payment Method Snapshot object. operationId: queryPaymentMethodSnapshotByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Method Snapshot object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentMethodSnapshot' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-runs: get: summary: List payment runs description: | Lists payment runs. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPaymentRuns parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - executeddate - numberofpayments - paymentrunnumber - status - targetdate - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Run object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - executeddate - numberofpayments - paymentrunnumber - status - targetdate - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryPaymentRunsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentRun' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-runs/{key}: get: summary: Retrieve a payment run description: | Retrieve the details of a specific Payment Run object. operationId: queryPaymentRunByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Run object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentRun' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-schedules: get: summary: List payment schedules description: | Lists payment schedules. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPaymentSchedules parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - number - accountid - invoiceid - debitmemoid - occurrences - status - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Schedule object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - number - accountid - invoiceid - debitmemoid - occurrences - status - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryPaymentSchedulesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentSchedule' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-schedules/{key}: get: summary: Retrieve a payment schedule description: | Retrieve the details of a specific Payment Schedule object. operationId: queryPaymentScheduleByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Schedule object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentSchedule' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-schedule-items: get: summary: List payment schedule items description: | Lists Payment Schedule Item objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPaymentScheduleItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - number - accountid - invoiceid - debitmemoid - paymentscheduleid - scheduleddate - status - paymentid - cancellationreason - in: query name: expand[] required: false schema: type: array items: type: string enum: - paymentscheduleitempayments - paymentscheduleitempayments.payment description: |- Allows you to expand responses by including related object information in a single call. The Payment Schedule Item object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - number - accountid - invoiceid - debitmemoid - paymentscheduleid - scheduleddate - status - paymentid - cancellationreason - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryPaymentScheduleItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentScheduleItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-schedule-items/{key}: get: summary: Retrieve a payment schedule item description: | Retrieve the details of a specific Payment Schedule Item object. operationId: queryPaymentScheduleItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/) in: header name: zuora-version required: false schema: type: string - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - paymentscheduleitempayments - paymentscheduleitempayments.payment description: |- Allows you to expand responses by including related object information in a single call. The Payment Schedule Item object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentScheduleItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balances: get: summary: List prepaid balances description: | Lists Prepaid Balance objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPrepaidBalances parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - startdate - accountid - origsubscriptionid - uom - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - origsubscription description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - startdate - accountid - origsubscriptionid - uom - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryPrepaidBalancesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPrepaidBalance' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balances/{key}: get: summary: Retrieve a prepaid balance description: | Retrieve the details of a specific Prepaid Balance object. operationId: queryPrepaidBalanceByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - origsubscription description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPrepaidBalance' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balance-funds: get: summary: List prepaid balance funds description: | Lists prepaid balance funds. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPrepaidBalanceFunds parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - enddate - prepaidbalanceid - sourceid - startdate - vpsummaryid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - prepaidbalance - source - vpsummary description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - enddate - prepaidbalanceid - sourceid - startdate - vpsummaryid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryPrepaidBalanceFundsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPrepaidBalanceFund' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balance-funds/{key}: get: summary: Retrieve a prepaid balance fund description: | Retrieve the details of a specific Prepaid Balance Fund object. operationId: queryPrepaidBalanceFundByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - prepaidbalance - source - vpsummary description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPrepaidBalanceFund' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balance-transactions: get: summary: List prepaid balance transactions description: | Lists prepaid balance transactions. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPrepaidBalanceTransactions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - accountid - prepaidbalanceid - fundid - sourceid - transactiondate - prepaidbalancetransactiontype - createddate - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - prepaidbalance - fund description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - accountid - prepaidbalanceid - fundid - sourceid - transactiondate - createddate - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryPrepaidBalanceTransactionsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPrepaidBalanceTransaction' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balance-transactions/{key}: get: summary: Retrieve a prepaid balance transaction description: | Retrieve the details of a Prepaid Balance Transaction object. operationId: queryPrepaidBalanceTransactionByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - prepaidbalance - fund description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPrepaidBalanceTransaction' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/processed-usages: get: summary: List processed usage records description: | Lists Processed Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryProcessedUsages parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - usageid - billingperiodenddate - billingperiodstartdate - in: query name: expand[] required: false schema: type: array items: type: string enum: - usage - invoiceitem - creditmemoitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - usageid - billingperiodenddate - billingperiodstartdate - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryProcessedUsagesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedProcessedUsage' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/processed-usages/{key}: get: summary: Retrieve a processed usage record description: | Retrieve the details of a specific Processed Usage Record object. operationId: queryProcessedUsageByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - usage - invoiceitem - creditmemoitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedProcessedUsage' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/products: get: summary: List products description: | Lists Product objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryProducts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - name - effectiveenddate - effectivestartdate - sku - productnumber - category - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplans - productrateplans.productrateplancharges - productrateplans.productrateplancharges.productrateplanchargetiers description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - name - effectiveenddate - effectivestartdate - sku - productnumber - category - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryProductsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedProduct' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/products/{key}: get: summary: Retrieve a product description: | Retrieve the details of a specific Product object. operationId: queryProductByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: ID or SKU of a product. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplans - productrateplans.productrateplancharges - productrateplans.productrateplancharges.productrateplanchargetiers description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedProduct' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plans: get: summary: List product rate plans description: | Lists Product Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryProductRatePlans parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - productid - name - effectivestartdate - effectiveenddate - productrateplannumber - in: query name: expand[] required: false schema: type: array items: type: string enum: - product - productrateplancharges - productrateplancharges.productrateplanchargetiers - externalproductrateplans description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - productid - name - effectivestartdate - effectiveenddate - productrateplannumber - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryProductRatePlansResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedProductRatePlan' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plans/{key}: get: summary: Retrieve a product rate plan description: | Retrieve the details of a specific Product Rate Plan object. operationId: queryProductRatePlanByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: ID of a product rate plan. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - product - productrateplancharges - productrateplancharges.productrateplanchargetiers - externalproductrateplans description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedProductRatePlan' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plan-charges: get: summary: List product rate plan charges description: | Lists Product Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryProductRatePlanCharges parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - billcycleday - chargemodel - productrateplanchargenumber - productrateplanid - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplan - productrateplanchargetiers description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - billcycleday - chargemodel - chargetype - isprepaid - productrateplanchargenumber - productrateplanid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryProductRatePlanChargesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedProductRatePlanCharge' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plan-charges/{key}: get: summary: Retrieve a product rate plan charge description: | Retrieve the details of a specific Product Rate Plan Charge object. operationId: queryProductRatePlanChargeByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: ID of a product rate plan charge. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplan - productrateplanchargetiers - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedProductRatePlanCharge' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plan-charge-tiers: get: summary: List product rate plan charge tiers description: | Lists Product Rate Plan Charge Tier objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryProductRatePlanChargeTiers parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - productrateplanchargeid - productchargedefinitionid - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - productrateplanchargeid - productchargedefinitionid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryProductRatePlanChargeTiersResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedProductRatePlanChargeTier' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plan-charge-tiers/{key}: get: summary: Retrieve a product rate plan charge tier description: | Retrieve the details of a specific Product Rate Plan Charge Tier object. operationId: queryProductRatePlanChargeTierByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: ID of a product rate plan charge tier. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedProductRatePlanChargeTier' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rate-plans: get: summary: List rate plans description: | Lists Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryRatePlans parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - productid - amendmentid - subscriptionid - subscriptionownerid - externallymanagedplanid - subscriptionrateplannumber - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - productrateplan - rateplancharges - rateplancharges.rateplanchargetiers description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - productid - amendmentid - subscriptionid - subscriptionownerid - invoiceownerid - externallymanagedplanid - originalrateplanid - subscriptionofferid - subscriptionrateplannumber - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryRatePlansResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRatePlan' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rate-plans/{key}: get: summary: Retrieve a rate plan description: | Retrieve the details of a specific Rate Plan object. operationId: queryRatePlanByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: ID of a rate plan. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - productrateplan - rateplancharges - rateplancharges.rateplanchargetiers description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRatePlan' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rate-plan-charges: get: summary: List rate plan charges description: | Lists Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results. **Note**: You must specify a `filter[]` query parameter to query rate plan charges. operationId: queryRatePlanCharges parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - rateplanid - chargenumber - invoicescheduleid - isprepaid - originalid - productchargedefinitionid - in: query name: expand[] required: false schema: type: array items: type: string enum: - rateplan - productrateplancharge - rateplanchargetiers description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: true schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - rateplanid - chargenumber - invoicescheduleid - isprepaid - originalid - subscriptionid - subscriptionownerid - invoiceownerid - productchargedefinitionid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryRatePlanChargesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRatePlanCharge' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rate-plan-charges/{key}: get: summary: Retrieve a rate plan charge description: | Retrieve the details of a specific Rate Plan Charge object. operationId: queryRatePlanChargeByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: ID of a rate plan charge. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - rateplan - productrateplancharge - rateplanchargetiers description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRatePlanCharge' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rate-plan-charge-tiers: get: summary: List rate plan charge tiers description: | Lists Rate Plan Charge Tier objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryRatePlanChargeTiers parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - currency - id - rateplanchargeid - updateddate - in: query name: expand[] required: false schema: type: array items: type: string enum: - rateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: true schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - currency - id - rateplanchargeid - updateddate - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryRatePlanChargesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRatePlanChargeTier' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rate-plan-charge-tiers/{key}: get: summary: Retrieve a rate plan charge tier description: | Retrieve the details of a specific Rate Plan Charge Tier object. operationId: queryRatePlanChargeTierByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: ID of a rate plan charge tier. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - currency - id - rateplanchargeid - updateddate - in: query name: expand[] required: false schema: type: array items: type: string enum: - rateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: true schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - currency - id - rateplanchargeid - updateddate - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRatePlanChargeTier' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rating-results: get: summary: List rating results description: | Lists Rating Result objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryRatingResults parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - subscriptionid - rateplanchargeid - servicestartdate - serviceenddate - status - ispartial - invoiceitemid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - rateplancharge - subscription - invoiceitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - subscriptionid - rateplanchargeid - servicestartdate - serviceenddate - status - ispartial - invoiceitemid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryRatingResultsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRatingResult' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rating-results/{key}: get: summary: Retrieve a rating result description: | Retrieve the details of a specific Rating Result object. operationId: queryRatingResultByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - rateplancharge - subscription - invoiceitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRatingResult' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refunds: get: summary: List refunds description: | Lists Refund objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryRefunds parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - paymentmethodsnapshotid - amount - paymentmethodid - reasoncode - refunddate - refundnumber - sourcetype - status - type - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - account.billto - account.soldto - paymentmethod - refundapplications - refundapplications.payment - refundapplications.refundapplicationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - paymentmethodsnapshotid - amount - paymentmethodid - reasoncode - refunddate - refundnumber - sourcetype - status - type - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryRefundsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRefund' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refunds/{key}: get: summary: Retrieve a refund description: | Retrieve the details of a specific Refund object. operationId: queryRefundByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - account.billto - account.soldto - paymentmethod - refundapplications - refundapplications.payment - refundapplications.refundapplicationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRefund' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refund-applications: get: summary: List refund applications description: | Lists Refund Application objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryRefundApplications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - applicationgroupid - creditmemoid - effectivedate - paymentid - refundid - in: query name: expand[] required: false schema: type: array items: type: string enum: - refund - payment - refundapplicationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - applicationgroupid - creditmemoid - effectivedate - paymentid - refundid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryRefundApplicationsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRefundApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refund-applications/{key}: get: summary: Retrieve a refund application description: | Retrieve the details of a specific Refund Application object. operationId: queryRefundApplicationByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - refund - payment - refundapplicationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRefundApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refund-application-items: get: summary: List refund application items description: | Lists Refund Application Item objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryRefundApplicationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - in: query name: expand[] required: false schema: type: array items: type: string enum: - refundapplication description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryRefundApplicationItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRefundApplicationItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refund-application-items/{key}: get: summary: Retrieve a refund application item description: | Retrieve the details of a specific Refund Application Item object. operationId: queryRefundApplicationItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - refundapplication description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRefundApplicationItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/summarystatementruns: get: summary: List summary statement runs description: | Lists statement runs. You can use the query parameters to filter, expand, and sort the returned results. operationId: getSummaryStatementRuns parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string enum: - endDate - startDate - statementRunNumber description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string enum: - accountId - id - startDate - statementRunNumber - status description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': description: | OK content: application/json: examples: response: value: accountId: 402881869169397401916d8ff8d218c5 createdbyId: 8a90e0828097f4a80180982735ff041d createdDate: '2024-09-03T20:20:55-10:00' emailStatus: Pending endDate: '2024-09-03' id: 8a90f17a91b7e1800191bbb176a243da startDate: '2024-09-03' statementDate: '2024-09-03' statementNumber: SS-00001979 statementRunId: 8a90b44891b7e1670191bbb16cef028a status: Completed updatedById: 8a90e0828097f4a80180982735ff041d updatedDate: '2024-08-20 10:13:57.586' success: true schema: $ref: '#/components/schemas/SummaryStatementOQResponse' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': description: | Invalid Input content: application/json: example: message: INVALID VALUE. The account number 123xProxy is invalid. schema: $ref: '#/components/schemas/ProxyBadRequestResponse' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/summarystatementruns/{key}: get: summary: Retrieve a summary statement run description: | Retrieves a statement run by using the statement run ID or number. operationId: getSummaryStatementRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Statement run ID or number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string enum: - endDate - startDate - statementRunNumber description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string enum: - accountId - id - startDate - statementRunNumber - status description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: examples: response: value: accountId: 402881869169397401916d8ff8d218c5 statementRunNumber: SSR-00000004 targetAccountCategory: AllAccounts runType: AdHoc batchName: Batch51 billCycleDay: '1' dateRangeType: PreviousThreeCalendarMonth startDate: '2024-05-01 19:13:57' endDate: '2024-07-31 19:13:57' autoEmailEnabled: false description: HelloWorld status: Pending createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2024-08-19 19:13:57' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2024-08-20 10:13:57.586' success: true schema: $ref: '#/components/schemas/SummaryStatementOQResponse' 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' '400': content: application/json: example: message: INVALID VALUE. The account number 123xProxy is invalid. schema: $ref: '#/components/schemas/ProxyBadRequestResponse' 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/summarystatements: get: summary: List summary statements description: | Lists summary statements. operationId: getSummaryStatements parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string enum: - endDate - statementDate - statementNumber description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string enum: - accountId - id - startDate - statementDate - statementNumber - statementRunId - status - emailStatus description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: examples: response: value: accountId: 402881869169397401916d8ff8d218c5 createdById: 8a90e0828097f4a80180982735ff041d createdDate: '2024-09-03T20:20:55-10:00' emailStatus: Pending endDate: '2024-09-03' id: 8a90f17a91b7e1800191bbb176a243da startDate: '2024-09-03' statementDate: '2024-09-03' statementNumber: SS-00001979 statementRunId: 8a90b44891b7e1670191bbb16cef028a status: Completed updatedById: 8a90e0828097f4a80180982735ff041d updatedDate: '2024-08-20 10:13:57.586' success: true schema: $ref: '#/components/schemas/SummaryStatementOQResponse' 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' '400': content: application/json: example: message: Bad Request schema: $ref: '#/components/schemas/ProxyBadRequestResponse' 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/summarystatements/{key}: get: summary: Retrieve a summary statement description: | Retrieves a statement based on the specified summary statement key. operationId: getSummaryStatement parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Statement ID or number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - endDate - statementDate - statementNumber - in: query name: expand[] required: false schema: type: array items: type: string enum: - createdById - createdDate - deleted - endDate - fileId - updatedById - updatedDate - errorCategory - errorMessage description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string enum: - accountId - id - startDate - statementDate - statementNumber - statementRunId - status - emailStatus description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: examples: response: value: accountId: 402881869169397401916d8ff8d218c5 createdById: 8a90e0828097f4a80180982735ff041d createdDate: '2024-09-03T20:20:55-10:00' emailStatus: Pending endDate: '2024-09-03' id: 8a90f17a91b7e1800191bbb176a243da startDate: '2024-09-03' statementDate: '2024-09-03' statementNumber: SS-00001979 statementRunId: 8a90b44891b7e1670191bbb16cef028a status: Completed updatedById: 8a90e0828097f4a80180982735ff041d updatedDate: '2024-08-20 10:13:57.586' success: true schema: $ref: '#/components/schemas/SummaryStatementOQResponse' 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' '400': content: application/json: example: message: INVALID VALUE. The account number 123xProxy is invalid. schema: $ref: '#/components/schemas/ProxyBadRequestResponse' 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/subscriptions: get: summary: List subscriptions description: | Lists Subscription objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: querySubscriptions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - contracteffectivedate - creatoraccountid - creatorinvoiceownerid - invoiceownerid - name - originalid - previoussubscriptionid - renewalterm - status - islatestversion - subscriptionversionamendmentid - termenddate - termstartdate - version - cmrr - externallymanagedby - invoicescheduleid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - invoiceowner - billtocontact - invoiceitems - rateplans - rateplans.rateplancharges - rateplans.rateplancharges.rateplanchargetiers - account.billto - account.soldto - account.paymentmethods - order description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - contracteffectivedate - creatoraccountid - creatorinvoiceownerid - invoiceownerid - name - originalid - previoussubscriptionid - renewalterm - status - islatestversion - subscriptionversionamendmentid - termenddate - termstartdate - version - cmrr - externallymanagedby - invoicescheduleid - quotenumber__qt - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QuerySubscriptionsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedSubscription' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/subscriptions/{key}: get: summary: Retrieve a subscription description: | Retrieve the details of a specific Subscription object. operationId: querySubscriptionByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - invoiceowner - billtocontact - invoiceitems - rateplans - rateplans.rateplancharges - rateplans.rateplancharges.rateplanchargetiers - account.billto - account.soldto - account.paymentmethods - order description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedSubscription' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/taxation-items: get: summary: List taxation items description: | Lists Taxation Item objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryTaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - invoiceitemid - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Taxation Item object does not support expanding related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - invoiceitemid - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryTaxationItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedTaxationItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/taxation-items/{key}: get: summary: Retrieve a taxation item description: | Retrieve the details of a specific Taxation Item object. operationId: queryTaxationItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Taxation Item object does not support expanding related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedTaxationItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/usages: get: summary: List usage records description: | Lists Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryUsages parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - accountnumber - enddatetime - quantity - rbestatus - startdatetime - uom - in: query name: expand[] required: false schema: type: array items: type: string enum: - account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - accountnumber - enddatetime - quantity - rbestatus - startdatetime - uom - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryUsagesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedUsage' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/usages/{key}: get: summary: Retrieve a usage record description: | Retrieve the details of a specific Usage Record object. operationId: queryUsageByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-insensitive filter on the list. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedUsage' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/validity-period-summaries: get: summary: List validity period summaries description: | Lists Validity Period Summary objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryValidityPeriodSummarys parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - prepaidbalanceid - startdate - subscriptionnumber - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - prepaidbalance description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-insensitive filter on the list. Supported filterable fields: - id - prepaidbalanceid - startdate - subscriptionnumber - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields. - in: query name: fields[] required: false schema: type: array items: type: string description: A case-insensitive query parameter that allows you to specify which fields are returned in the response. example: id,createddate responses: '200': content: application/json: schema: type: object title: QueryValidityPeriodSummarysResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedValidityPeriodSummary' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request 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' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' 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: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse'