Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
You can use amendments to modify subscriptions. However, Zuora recommends you to use the [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order/) operation to do so. - name: Bill Runs description: | This section contains the CRUD bill run operations, including: - [CRUD: Create a bill run](https://developer.zuora.com/api-references/older-api/operation/Object_POSTBillRun/) - [CRUD: Retrieve a bill run](https://developer.zuora.com/api-references/older-api/operation/Object_GETBillRun/) - [CRUD: Post or cancel a bill run](https://developer.zuora.com/api-references/older-api/operation/Object_PUTBillRun/) - [CRUD: Delete a bill run](https://developer.zuora.com/api-references/older-api/operation/Object_DELETEBillRun/) - name: Contacts 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: Catalog 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. \n" - name: Charge Metrics description: 'Charge Metrics provides a service to access key metrics for rate plan charges in Zuora, for example, Gross MRR, Net MRR, Gross TCV, and Net TCV. ' - name: Charge Revenue Summaries description: | The Charge Revenue Summary represents a summary of revenue amounts from all revenue schedules on the whole subscription charge. For example, revenue for one-time setup charges, recurring charges, and overages. You can [list all details of a charge revenue summary](https://developer.zuora.com/api-references/older-api/operation/GET_CRSByCRSNumber/) or [retrieve a charge revenue summary by charge ID](https://developer.zuora.com/api-references/older-api/operation/GET_CRSByChargeID/) through the REST API. - name: Communication Profiles description: | A communication profile enables you to send specific event-driven notifications to targeted customer accounts. For more information, see [Communication profiles](https://knowledgecenter.zuora.com/Central_Platform/Notifications/C_Viewing_Profiles). You can manage communication profiles using the REST API: - [CRUD: Retrieve a communication profile](https://developer.zuora.com/api-references/older-api/operation/Object_GETCommunicationProfile/) - [Retrieve all notifications under a communication profile (using the Settings API)](https://knowledgecenter.zuora.com/Central_Platform/API/BB_C_Settings_API/Settings_API_tutorials/Get_all_Notifications_under_a_particular_Communication_Profile) - [Retrieve all communication profiles (using the Settings API)](https://knowledgecenter.zuora.com/Central_Platform/API/BB_C_Settings_API/Settings_API_tutorials/Get_all_Communication_Profiles) - [Update a communication profile (using the Settings API)](https://knowledgecenter.zuora.com/Central_Platform/API/BB_C_Settings_API/Settings_API_tutorials/Modify_a_Communication_Profile) - [Create a communication profile (using the Settings API)](https://knowledgecenter.zuora.com/Central_Platform/API/BB_C_Settings_API/Settings_API_tutorials/Create_a_new_Communication_Profile) - name: Connections description: | Establishes a connection to the Zuora REST API service based on a valid user credentials. **Note:** This is a legacy REST API. Zuora recommends you to use [OAuth](https://developer.zuora.com/api-references/api/tag/OAuth/) for authentication instead. - name: Credit Balance Adjustments description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
A credit balance adjustment represents one adjustment made to the credit balance. ' - name: Document Properties description: "You can create, update, and retrieve custom document properties for\ \ a billing document. For example, a document property can be a custom name used\ \ for files generated for billing documents. Billing documents include invoices,\ \ credit memos, and debit memos.\n\n**Note**: You can manage document properties\ \ for credit memos and debit memos only if you have the Invoice Settlement feature enabled. \n" - name: Entities description: "An entity represents a business unit that operates independently and\ \ can sell products to multiple countries. Each entity has its own Zuora environment\ \ in which the entity users can perform business operations independent of the\ \ other entities. In a multi-entity hierarchy, an entity can share certain business\ \ objects with the other entities. Users that are created in an entity can be\ \ granted access to the other entities with different roles and permissions. \n\ \n**Note**: Entities are available only if you have the Multi-entity feature enabled. If you want to have access\ \ to the Multi-entity feature, submit a request at Zuora Global Support. \n" - name: Entity Connections description: "If you want to share business objects across entities, you have to\ \ set up a connection between the source entity and the target entity first.\n\ \n**Note**: Entity connections are available only if you have the Multi-entity feature enabled. If you want to have access\ \ to the Multi-entity feature, submit a request at Zuora Global Support. \n" - name: Exports description: | You can export items from Zuora to CSV or HTML files, such as large data sets, invoices, payments, and so on. Use the Export object and Export ZOQL queries to create an export file that you can download and use for charting, reporting, accounting, or for other business intelligence uses. When you export data from Zuora, each exported file is available for download for 7 days. Export objects older than 90 days are automatically deleted. - name: Features description: "After you have created a feature, you can add features to the products\ \ and subscriptions to enhance your product offerings.\n\nTo create features in\ \ the product catalog and use them in subscriptions and Zuora Quotes, you need\ \ to enable the following:\n- The Entitlements setting in your tenant. Access\ \ to the Entitlements feature requires a specific edition of Zuora. For more information,\ \ see Zuora Editions. \n- The Enable Feature Specification in Product and Subscriptions\ \ setting in the Billing Settings.\n" - name: HMAC Signatures description: "A Hash-based Message Authentication Code (HMAC) signature is a form\ \ of a digital signature. HMAC signatures start with a secret key that is shared\ \ between the sender and the recipient. \n\nYou can use the operation contained\ \ in this section to generate the unique signature and token values that are used\ \ to process CORS-enabled API calls.\n" - name: Invoice Adjustments description: |Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
An invoice adjustment modifies an existing invoice. You use an invoice adjustment to change the entire invoice. For example, you can apply a late fee to the invoice balance. An invoice adjustment differs from an invoice item adjustment. An invoice item adjustment affects an individual charge or line item on an invoice. An invoice adjustment affects the invoice at the header-level. **Note**: Invoice Adjustment is deprecated on Production in WSDL version 64.0. Zuora recommends that you use the Invoice Item Adjustment to adjust invoices. If you have the Invoice Settlement feature enabled, this object is deprecated and only available for backward compatibility. - name: Invoice Item Adjustments description: |Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
Invoice item adjustments allow you to adjust the invoice details, including taxes at the charge level, and have those adjustments reported in the system under the same accounting code as the items that are being adjusted. **Note**: The Invoice Settlement feature is a replacement for Invoice Item Adjustments. We recommend that you enable Invoice Settlement to take advantage of the improved functionalities. If you have the Invoice Settlement feature enabled, the Invoice Item Adjustments feature is deprecated and invoice item adjustments are not presented in the UI. If you have to export data for invoice item adjustments, use Data Source, Data Query, or REST API. - name: Invoice Items description: 'Invoice items are the line items contained in the invoices that you send to your customers. For more information about invoices, see Invoices. ' - name: Invoice Payments description: 'Use invoice payments to tie a payment to an invoice and indicate how much of the payment was applied to the invoice. ' - name: Invoice Split Items description: 'Use invoice split items to split the original invoice into multiple invoices. ' - name: Invoice Splits description: 'Use invoice splits to hold two or more invoice split items. ' - name: Invoices description: "Invoices provides information about customers' accounts for invoices,\ \ for examples, dates, status, and amounts. \n\nFor more information about invoices,\ \ see Invoice.\n" - name: Orders description: "Orders are contractual agreements between merchants and customers.\ \ \n\nFor more information about Orders, see Orders. \n" - name: Payment Gateway Transaction Logs description: 'You can use the [Retrieve a payment gateway transaction log](https://developer.zuora.com/api-references/older-api/operation/GET_PaymentGatewayTransactionLog/) operation to retrieve log data about all transactions processed through your setup payment gateways. ' - name: Payment Methods description: 'Payment methods represents payment method details associated with a customer account. ' - name: Payments description: | Use payments to process payments, for example, automate recurring payments, manage overpayments, and create refunds. For more information about payments, see Payments. - name: Product Features description: "You can add features to products through the Zuora UI. \nHowever,\ \ you can retrieve or delete product features through the UI or API.\n" - name: Quotes Document description: "This section contains the [Generate a quote document](https://developer.zuora.com/api-references/older-api/operation/POST_QuotesDocument/)\ \ operation that should be only used from Zuora Quotes. \n\nThis operation\ \ generates a quote document and returns the generated document URL. You can directly\ \ access the generated quote file through the returned URL.\n" - name: Rate Plan Charge Tiers description: "A rate plan charge tier is part of a subscription or an amendment\ \ to a subscription, and it comes from a product rate plan charge tier. A rate\ \ plan charge tier holds the prices for a rate plan charge. Each rate plan charge\ \ has at least one tier associated with it.\n\nRate plan charge tiers are sometimes\ \ called subscription rate plan charge tiers to distinguish them from product\ \ rate plan charge tiers. \nRate plan charge tiers that are part of an amendment\ \ are sometimes called amendment rate plan charge tiers for the same reason. However,\ \ the object name is RatePlanChargeTier, not SubscriptionRatePlanChargeTier nor\ \ AmendmentRatePlanChargeTier: these latter two names don't exist.\n" - name: Rate Plan Charges description: "A rate plan charge is part of a subscription or an amendment to a\ \ subscription, and it comes from a product rate plan charge. Like a product and\ \ its product rate plan charges, a subscription can have one or more rate plan\ \ charges. Rate plan charges represent the actual charges for the rate plans or\ \ services that you sell.\n\nRate plan charges are sometimes called subscription\ \ rate plan charges to distinguish them from product rate plan charges. Rate plan\ \ charges that are part of an amendment are sometimes called amendment rate plan\ \ charges for the same reason. The object name is RatePlanCharge \u2013 not SubscriptionRatePlanCharge\ \ nor AmendmentRatePlanCharge.\n" - name: Rate Plans description: "A rate plan is part of a subscription or an amendment to a subscription,\ \ and it comes from a product rate plan. Like a product and its product rate plans,\ \ a subscription can have one or more rate plans. \nRate plans are sometimes called\ \ subscription rate plans. Rate plans that are part of an amendment are sometimes\ \ called amendment rate plans.\n\nRate plans represent a price or a collection\ \ of prices for a service you sell. An individual rate plan contains all charges\ \ specific to a particular subscription.\n" - name: Refund Invoice Payments description: | This section contains the [CRUD: Retrieve a refund invoice payment](https://developer.zuora.com/api-references/older-api/operation/Object_GETRefundInvoicePayment/) operation. You can use this operation to retrieve information from Refund Invoice Payment and associated invoices, payments, and accounts. - name: Refund Transaction Logs description: | This section contains the [CRUD: Retrieve a refund transaction log](https://developer.zuora.com/api-references/older-api/operation/Object_GETRefundTransactionLog/) operation. This operation allows you to export a log of all transactions from Zuora to the gateway for the refund. - name: Refunds description: "Zuora allows you to issue and track refunds on payments. Similar to\ \ external payments, users can enter external refunds to track refunds that have\ \ been performed outside of Zuora Payments (for example, by issuing a check).\ \ \nIn addition, you can make electronic refunds using our supported payment gateways,\ \ which will automatically refund money to the customer.\n" - name: Reporting description: | Contact Zuora Global Support to enable this feature in your tenant. This feature is currently in development and is subject to change without advance notice. The Zuora Reporting API enables you to access reports that you have created in the Zuora UI, manage report runs, and export the results of report runs. The endpoints of the Reporting API are the same as the [endpoints of Zuora REST API](https://developer.zuora.com/api-references/api/overview/#section/Introduction/Access-to-the-API). The following table provides some endpoints as reference: | Environment | API Endpoint | | ------------------------------------ | ----------------------------------------------------------- | | API Sandbox (US Cloud Data Center 1) | https://rest.sandbox.na.zuora.com | | Production (US Cloud Data Center 1) | https://rest.na.zuora.com | | API Sandbox (US Cloud Data Center 2) | https://rest.apisandbox.zuora.com | | Production (US Cloud Data Center 2) | https://rest.zuora.com | | API Sandbox (EU Data Center) | https://rest.sandbox.eu.zuora.com | | Production (EU Data Center) | https://rest.eu.zuora.com | | US Central Sandbox | https://rest.test.zuora.com | | EU Central Sandbox | https://rest.test.eu.zuora.com | Historically, the endpoints of the Reporting API were different from the endpoints of the Zuora REST API. Note that you are still able to use the following endpoints, but it is unrecommended and you can only use username and password to authenticate to the Reporting API. We recommend you to use [OAuth](https://developer.zuora.com/rest-api/general-concepts/authentication/) to authenticate to the Reporting API. OAuth only works with new endpoints. The endpoints of the Reporting API were: | Environment | API Endpoint | | ------------------------------------ | ----------------------------------------------------------- | | API Sandbox (US Cloud Data Center 1) | https://zconnect.sandbox.na.zuora.com/api/rest/v1 | | Production (US Cloud Data Center 1) | https://zconnect.na.zuora.com/api/rest/v1 | | API Sandbox (US Cloud Data Center 2) | https://zconnectsandbox.zuora.com/api/rest/v1 | | Production (US Cloud Data Center 2) | https://zconnect.zuora.com/api/rest/v1 | | API Sandbox (EU Data Center) | https://zconnect.sandbox.eu.zuora.com/api/rest/v1 | | Production (EU Data Center) | https://zconnect.eu.zuora.com/api/rest/v1 | | US Central Sandbox | https://zconnect-services0001.test.zuora.com/api/rest/v1 | | EU Central Sandbox | https://zconnect-services0002.test.eu.zuora.com/api/rest/v1 | - name: Revenue Events description: "A revenue event is a record or audit trail about a change to a revenue\ \ schedule. \nWhen you manually distribute revenue schedule, if no change is made\ \ to the revenue schedule, no revenue events will not be created. \n\nA revenue\ \ event is comprised of:\n- **Date**: The date when the event occurred.\n- **Revenue\ \ Event Type**: The action or activity triggering the revenue event. \n- **Recognition\ \ Start** and **Recognition End**: The start and end dates for the revenue recognition\ \ period.\n- **Revenue Item**: The distribution of revenue (or adjustments) into\ \ accounting periods. \n" - name: Revenue Items description: "Revenue Item is a component of a revenue event, representing the distribution\ \ of revenue (or adjustments) into accounting periods. \n" - name: Revenue Rules description: 'Revenue rules are instances of revenue rule models. These rules are associated with product rate plan charges. Rules help manage revenue recognition on subscription charges. ' - name: Revenue Schedules description: 'A revenue schedule represents how revenue amounts from a single charge are distributed over time and recognized in accounting periods. Revenue schedules maintain consistency with the currency used. ' - name: Subscription Product Features description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
The Entitlements settings must be enabled to use this operation. Access to the Entitlements feature requires a specific edition of Zuora. See [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for details. - name: Subscriptions description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
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: Taxation Items 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: Transactions description: | You can view all transactions associated with an account, including: - [List all invoices for an account](https://developer.zuora.com/api-references/older-api/operation/GET_TransactionInvoice/) - [List all payments for an account](https://developer.zuora.com/api-references/older-api/operation/GET_TransactionPayment/) - name: Unit Of Measure description: "A unit of measure (UOM) is the definable unit that you measure when\ \ determining charges. For example, if a customer's subscription rate plan includes\ \ 20 licenses, then 20 is the quantity and license is the unit that the quantity\ \ measures. \n\nYou can customize the units of measure (UOM) your company uses\ \ to measure the use of your services; for example, minutes, people, seats, and\ \ licenses can all be units of measure.\n" - name: Users description: | You can use the Users operations only if you have the Multi-entity feature enabled. For detailed information about the Multi-entity feature, see Multi-entity. parameters: GLOBAL_HEADER_Authorization_OAuth: name: Authorization in: header required: true type: string description: 'The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://developer.zuora.com/api-references/api/operation/createToken). ' GLOBAL_HEADER_Authorization_OAuth_optional: name: Authorization in: header required: false type: string description: 'The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://developer.zuora.com/api-references/api/operation/createToken). ' GLOBAL_HEADER_Zuora_Entity_Ids_Single: name: Zuora-Entity-Ids in: header required: false type: string description: 'An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. ' GLOBAL_HEADER_Zuora_Track_Id: name: Zuora-Track-Id in: header required: false type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`). GLOBAL_REQUEST_page: name: page in: query required: false type: integer minimum: 1 default: 1 description: 'The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response. ' GLOBAL_REQUEST_pageSize: name: pageSize in: query required: false type: integer maximum: 40 default: 20 description: 'The number of records returned per page in the response. ' GLOBAL_REQUEST_pageSize_finance_accounting: name: pageSize in: query required: false type: integer maximum: 300 default: 300 description: 'The number of records returned per page in the response. ' GLOBAL_REQUEST_pageSize_finance_revenue: name: pageSize in: query required: false type: integer maximum: 300 default: 8 description: 'The number of records returned per page in the response. ' GLOBAL_REQUEST_pageSize_entityConnection: name: pageSize in: query required: false type: integer maximum: 300 default: 30 description: 'The number of records returned per page in the response. ' GLOBAL_HEADER_X_Zuora_WSDL_Version: name: X-Zuora-WSDL-Version in: header required: false type: string default: 79 description: 'Zuora WSDL version number. ' GLOBAL_REQUEST_rejectUnknownFields: name: rejectUnknownFields in: query required: false type: boolean default: false description: | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: ```json { "message": "Error - unrecognised fields" } ``` By default, Zuora ignores unknown fields in the request body. GLOBAL_HEADER_Charge_Metrics_Accept: name: Accept in: header required: false type: string description: 'Expressed as MIME types that the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the `Content-Type` response header. The possible response MIME types are `application/json-seq` compatible with http://jsonlines.org/, and `text/csv` compatible with RFC 4180. `application/json-seq` is the default response MIME type. If the `Accept` header is not sepecified, or set */*, the response body is returned in application/json-seq MIME type. ' GLOBAL_HEADER_Idempotency_Key: name: Idempotency-Key in: header required: false type: string maxLength: 255 description: "Specify a unique idempotency key if you want to perform an idempotent\ \ POST or PATCH request. Do not use this header in other request types. \n\n\ With this header specified, the Zuora server can identify subsequent retries\ \ of the same request using this value, which prevents the same operation from\ \ being performed multiple times by accident. \n" GLOBAL_HEADER_Accept_Encoding: name: Accept-Encoding in: header required: false type: string description: "Include the `Accept-Encoding: gzip` header to compress responses\ \ as a gzipped file. It can significantly reduce the bandwidth required for\ \ a response. \n\nIf specified, Zuora automatically compresses responses that\ \ contain over 1000 bytes of data, and the response contains a `Content-Encoding`\ \ header with the compression algorithm so that your client can decompress it.\n" GLOBAL_HEADER_Content_Encoding: name: Content-Encoding in: header required: false type: string description: 'Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. ' paths: /v1/action/amend: post: summary: Amend operationId: Action_POSTamend description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
Modifies a subscription by creating Amendment objects. However, to modify a subscription, Zuora recommends that you use the [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order/) operation instead of this action. The Amend action cannot modify the custom fields on the Subscription object. You can use the [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order/) operation to modify the custom fields on the Subscription object. You can use this action to create up to 10 Amendment objects. You must specify the following fields for each Amendment object: * `ContractEffectiveDate` * `Name` * `SubscriptionId` * `Type` Additionally, the value of `SubscriptionId` must be the same for each Amendment object. You cannot use this operation to update multiple subscriptions. When you call this operation, Zuora modifies the subscription in the order that you specify Amendment objects in the request body. If Zuora is unable to create an Amendment object when you call this operation, the entire call fails. **Amendment Preview** To view taxation item data for invoices and credit memos in the amendment preview response, you need to set the `X-Zuora-WSDL-Version` request header to `120` or later. tags: - Actions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: amendRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyActionamendRequest' responses: '200': examples: application/json: results: - SubscriptionId: 8ad09be490a1ec6a0190a56eb69d4cd3 TotalDeltaMrr: 0 TotalDeltaTcv: 0 AmendmentIds: - 8ad09be490a1ec6a0190a56eb5f04ccd Success: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyActionamendResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/action/execute: post: summary: Execute operationId: Action_POSTexecute description: "Use the execute call to execute a process to split an invoice\ \ into multiple invoices. The original invoice must be in draft status. The\ \ resulting invoices are called split invoices.\n\nTo access this feature,\ \ see [Enable Splitting Invoices](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Splitting_Invoices#Enable_Splitting_Invoices)\ \ for steps. \n\nTo split a draft invoice into multiple split invoices:\n\n\ 1. Use the create call to create a single InvoiceSplit object to collect all\ \ of the InvoiceSplitItem objects.\n2. Use the create call to create a separate\ \ InvoiceSplitItem object for each split invoice that you want to create from\ \ the original draft invoice.\n3. Use the execute call to split the draft\ \ invoice into multiple split invoices.\n\nYou need to create InvoiceSplitItem\ \ objects and an InvoiceSplit object before you can use the execute call.\ \ \n\n* Supported objects: InvoiceSplit\n* Asynchronous process: yes\n" tags: - Actions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: executeRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyActionexecuteRequest' responses: '200': examples: application/json: - Success: true Id: 2c93808457d787030157e031d5844c53 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: description: '' type: array items: $ref: '#/definitions/ExecuteResult' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/action/generate: post: summary: Generate operationId: Action_POSTgenerate description: | Generates an on-demand invoice for a specific customer. This is similar to creating an ad-hoc bill run for a specific customer account in the Zuora UI. * Supported objects: Invoice * Asynchronous process: yes The ID of the generated invoice is returned in the response. If multiple invoices are generated, only the id of the first invoice generated is returned. This occurs when an account has multiple subscriptions with the [invoice subscription separately](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/B_Creating_Subscriptions/Invoicing_Subscriptions_Separately) option enabled. tags: - Actions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: generateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyActiongenerateRequest' responses: '200': examples: application/json: - Success: true Id: 2c93808457d787030157e0306cd13a86 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: description: '' type: array items: $ref: '#/definitions/SaveResult' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/action/subscribe: post: summary: Subscribe operationId: Action_POSTsubscribe description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
This call performs many actions. Use the subscribe call to bundle information required to create at least one new subscription. The call takes in an array of SubscribeRequests. Because it takes an array, you can submit a batch of subscription requests at once. You can create up to 50 different subscriptions in a single subscribe call. This is a combined call that you can use to perform all of the following tasks in a single call: * Create accounts * Create contacts * Create payment methods, including external payment options * Create an invoice for the subscription * Apply the first payment to a subscription ### Object Limits * 50 objects are supported in a single call. * The subscribe call for subscription preview will not consolidate invoices. Subscriptions are previewed separately. There is not any workaround without Orders enabled. For more information, see [Preview an Order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder). ### Effective Date If the effective date is in the future, the invoices will not be generated, and there will be no invoice number. ### Subscription Name, Number, and ID #### Subscription Name and Number The subscription name is a unique identifier for the subscription. If you do not specify a value for the name, Zuora will create one automatically. The automatically generated value is known as the subscription number, such as `A-S00000080`. You cannot change the subscription name or number after creating the subscription. - **Subscription name**: The name that you set for the subscription. - **Subscription number**: The value generated by Zuora automatically if you do not specify a subscription name. Both the subscription name and numbermust be unique. If they are not, an error will occur. #### Subscription ID The subscription ID is a 32-digit ID in the format 4028xxxx. This is also the unique identifier for a subscription. This value is automatically generated by the system and cannot be edited or updated, but it can be queried. One subscription can have only one subscription name or number, but it can have multiple IDs: Each version of a subscription has a different ID. The Subscription object contains the fields `OriginalId` and `PreviousSubscriptionId`. `OriginalId` is the ID for the first version of a subscription. `PreviousSubscriptionId` is the ID of the version created immediately prior to the current version. ### Subscription Preview You can preview invoices that would be generated by the subscribe call. When previewing invoices with the subscribe call, the correspondinig Contract Effective, Service Activation, or Customer Acceptance date is required if the subscription contains a charge with its trigger event being set as `ContractEffectiveDate`, `ServiceActivationDate`, or `CustomerAcceptanceDate`. To view taxation item data for invoices and credit memos in the subscription preview response, you need to set the `X-Zuora-WSDL-Version` request header to `120` or later. ### Invoice Subscriptions Separately If you have enabled the invoice subscriptions separately feature, a subscribe call will generate an invoice for each subscription for every subscription where the field `IsInvoiceSeparate` is set to `true`. If the invoice subscriptions separately feature is disabled, a subscribe call will generate a single invoice for all subscriptions. See [Invoicing Subscriptions Separately](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/B_Creating_Subscriptions/Invoicing_Subscriptions_Separately) for more information. ### Subscriptions and Draft Invoices If a draft invoice that includes charges exists in a customer account, using the subscribe call to create a new subscription and generate an invoice will cause the new subscription to be added to the existing draft invoice. Zuora will then post the invoice. ### When to Use Subscribe and Create Calls You can use either the subscribe call or the create call to create the objects associated with a subscription (accounts, contacts, and so on). There are differences between these calls, however, and some situations are better for one or the other. #### Use the Subscribe Call The subscribe call bundles up all the information you need for a subscription. Use the subscribe call to create new subscriptions when you have all the information you need. Subscribe calls cannot update BillTo, SoldTo, and Account objects. Payment information objects cannot be updated if there is an existing account ID in the call. These objects are not supported in a subscribe call. #### Use the Create Call The create call is more useful when you want to develop in stages. For example, if you want to first create an account, then a contact, and so on. If you do not have all information available, use the create call. To create a subscription, you must activate the account from Draft status to Active by calling the subscribe call. tags: - Actions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: subscribeRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyActionsubscribeRequest' responses: '200': examples: application/json: - Success: true AccountId: 8ad09be4909fc0f80190a0b18f85137e AccountNumber: A00000118 SubscriptionId: 8ad09be4909fc0f80190a0b1906b13c4 SubscriptionNumber: A-S00000138 InvoiceId: 8ad09be4909fc0f80190a0b192ca13f9 InvoiceNumber: INV00000152 InvoiceResult: Invoice: - Id: 8ad09be4909fc0f80190a0b192ca13f9 InvoiceNumber: INV00000152 TotalTcv: 179.88 TotalMrr: 14.99 PaymentId: 8ad09be4909fc0f80190a0b193951425 PaymentTransactionNumber: '5687098.81309958' GatewayResponse: This transaction has been approved by Test gateway. GatewayResponseCode: Approved description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: description: '' type: array items: $ref: '#/definitions/SubscribeResult' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/amendments/{amendment-key}: get: summary: Retrieve an amendment operationId: GET_AmendmentsByKey description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
Retrieves detailed information about the specified subscription amendment. tags: - Amendments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: amendment-key in: path description: Can be the amendment ID or the amendment code. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true id: 402896a9529c100a01529c30e26a0018 code: A-AM00000002 name: testAmendment type: TermsAndConditions description: just for test status: Completed contractEffectiveDate: '2016-02-01' serviceActivationDate: '2016-02-01' customerAcceptanceDate: '2016-02-01' effectiveDate: '2016-02-01' newSubscriptionId: 402896a9529c100a01529c311930001d baseSubscriptionId: 402896a9529c100a01529c2f2cc30010 termType: TERMED currentTerm: 2 currentTermPeriodType: Month termStartDate: '2015-12-31' renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerm: 1 renewalTermPeriodType: Month autoRenew: false specificUpdateDate: null newRatePlanId: null baseRatePlanId: null destinationAccountId: 402896a9529bc3dc01529bcba7120023 destinationInvoiceOwnerId: 402896a9529bc3dc01529bcba7120023 subType: Upgrade effectivePolicy: EffectiveImmediately description: '' schema: $ref: '#/definitions/GETAmendmentType' /v1/amendments/subscriptions/{subscription-id}: get: summary: Retrieve the last amendment of a subscription operationId: GET_AmendmentsBySubscriptionID description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
Retrieves detailed information about the last amendment of the specified subscription. tags: - Amendments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: subscription-id in: path description: The ID of the subscription whose amendment changes you want to retrieve. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true id: 402896a9529c100a01529c30e26a0018 code: A-AM00000002 name: testAmendment type: TermsAndConditions description: just for test status: Completed contractEffectiveDate: '2016-02-01' serviceActivationDate: '2016-02-01' customerAcceptanceDate: '2016-02-01' effectiveDate: '2016-02-01' newSubscriptionId: 402896a9529c100a01529c311930001d baseSubscriptionId: 402896a9529c100a01529c2f2cc30010 termType: TERMED currentTerm: 2 currentTermPeriodType: Month termStartDate: '2015-12-31' renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerm: 1 renewalTermPeriodType: Month autoRenew: false specificUpdateDate: null newRatePlanId: null baseRatePlanId: null destinationAccountId: 402896a9529bc3dc01529bcba7120023 destinationInvoiceOwnerId: 402896a9529bc3dc01529bcba7120023 description: '' schema: $ref: '#/definitions/GETAmendmentType' /v1/catalog/products/{product-id}/share: post: summary: 'Multi-entity: Share a product with an entity' operationId: POST_Catalog description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/).\n\nShares a product with a target entity.\ \ Zuora synchronizes the shared products to the target entity after sharing.\ \ For more information about product sharing, see [Products Sharing Across\ \ Entities](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/C_Business_Objects_Sharing_Across_Entities/B_Products_Sharing_Across_Entities).\n\ \nNote that:\n\n- You must finish all the [prerequisites](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/C_Business_Objects_Sharing_Across_Entities/B_Products_Sharing_Across_Entities/Share_Products)\ \ before sharing products with other entities. \n\n- Only source entity administrators\ \ have permission to share products with other entities. You must make the\ \ call as a source entity administrator.\n\n- Currently, you can only share\ \ a product with one entity at a time. An error occurs if you try to share\ \ a product to more than one entity.\n" tags: - Catalog parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: product-id in: path description: The unique ID of the product you want to share. For example, 8a808255575bdae4015774e9602e16fe. required: true type: string - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTCatalogType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' # CREATE BILL RUN '/v1/object/bill-run': post: summary: 'CRUD: Create a bill run' operationId: Object_POSTBillRun description: | Creates an ad hoc bill run or a single account or multiple customer accounts. When creating a single account ad hoc bill run, your request must include `AccountId` and must not include `Batch` or `BillCycleDay`. If more than 500 bill runs created by using this operation are in Pending status, no more bill runs can be created by using this operation. tags: - Bill Runs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: CreateRequest in: body description: "" required: true schema: $ref: '#/definitions/ProxyCreateBillRun' responses: '200': examples: application/json: { "Success": true, "Id": "2c92c0f959d961e1015a0872b69a7347" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: { "Errors":[ { "Code": "INVALID_VALUE", "Message": "The account number 123xProxy is invalid." } ], "Success": false } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: { "message": "Authentication error" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '/v1/object/bill-run/{id}': get: summary: 'CRUD: Retrieve a bill run' operationId: Object_GETBillRun description: | Retrieves information about a bill run. Business operations depending on the completion of the bill run will not be available while the bill run query returns `PostInProgress`. Upon completion of the bill run, a query will return `Posted`. tags: - Bill Runs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: fields in: query required: false type: string description: "Object fields to return" - name: id in: path description: "Object id" required: true type: string responses: '200': examples: application/json: { "AutoRenewal": false, "InvoiceDate": "2017-02-01", "Id": "2c92c09459d949220159f79d592f7e1a", "NumberOfInvoices": 1, "UpdatedDate": "2017-02-01T19:00:00.000-08:00", "BillCycleDay": "AllBillCycleDays", "AutoEmail": false, "AutoPost": false, "NoEmailForZeroAmountInvoice": false, "NumberOfAccounts": 1, "BillRunNumber": "BR-00002572", "Status": "Completed", "CreatedDate": "2017-01-31T19:00:01.000-08:00", "CreatedById": "2c92c0f956bc8fcb0156f8eee04b4d54", "UpdatedById": "2c92c0f956bc8fcb0156f8eee04b4d54", "ExecutedDate": "2017-02-01T19:00:00.000-08:00", "Batch": "Batch1", "InvoicesEmailed": false, "TargetDate": "2017-02-20" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyGetBillRun' '401': examples: application/json: { "message": "Authentication error" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: { "records":{}, "size":0, "done":true } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyNoDataResponse' # PUT BILL RUN put: summary: 'CRUD: Post or cancel a bill run' operationId: Object_PUTBillRun description: | Posts or cancels a bill run. ### Post a Bill Run Posting a bill run is an asynchronous operation. To post a bill run, the current bill run must have a status of `Completed`. When a bill run is posted, its status is changed to `PostInProgress`. Once all invoices for this bill run are posted then its status is changed to `Posted`. When you post a bill run and query the status of a bill run, you will get one of the following results `PostInProgress`, `Completed`, or `Posted`. If all invoices in the bill run are posted, then the status of the bill run is `Posted`. If one or more invoices fail to post, the status will change back to `Completed` and you will need to post the bill run again. ### Cancel a Bill Run Canceling a bill run is an asynchronous operation. When canceling a bill run, the logic is the same as when using the UI to cancel a bill run. You need to provide the `BillRunId`, and set the Status to `Canceled`. When canceling a bill run, consider the following: * Canceling a bill run with a `Completed` status. * Only the current bill run will be canceled. * Canceling a bill run with a `Pending` status. * When canceling an Ad-hoc bill run, only the current bill run will be canceled. * When canceling a scheduled bill, all scheduled bill runs will be canceled. The Cancel operation may not be successful. Its success depends on its current business validation. Only a bill run that has no posted invoices can be canceled. If any posted invoices belong to the bill run then an invalid value exception will be thrown with the message, "The Bill Run cannot be Cancelled, There are Posted invoices." tags: - Bill Runs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: "" required: true schema: $ref: '#/definitions/ProxyModifyBillRun' responses: '200': examples: application/json: { "Success": true, "Id": "2c92c0f959d961e1015a0872b69a7347" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: { "message": "Authentication error" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' # DELETE Bill Run delete: summary: 'CRUD: Delete a bill run' operationId: Object_DELETEBillRun description: | Deletes a bill run. When deleting a bill run, the logic is the same as when using the UI to delete a bill run. The only required parameter is `BillRunId`. The Status for the bill run must be `Canceled` in order to delete a bill run. tags: - Bill Runs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: { "Success": true, "Id": "2c92c0f959d961e1015a0872b69a7347" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: { "message": "Authentication error" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /charge-metrics/data/charge-metrics: get: summary: List charge metrics by time range description: "Retrieves key charge metrics about rate plan charges that have\ \ changes in a specified time range.\n\nThe purpose of `fromTimestamp` and\ \ `toTimestamp` is to synchronize charge metrics data incrementally. \n" operationId: GET_ChargeMetrics tags: - Charge Metrics parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Charge_Metrics_Accept' - name: fromTimestamp description: 'The starting date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example, `2020-08-18T09:01:11Z`. The timestamp maps to the `UpdatedOn` timestamp of the to-be-exported object. ' in: query required: true type: string format: date-time - name: toTimestamp description: 'The end date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example, `2020-08-20T09:01:11Z`. The timestamp maps to the `UpdatedOn` timestamp of the to-be-exported object. ' in: query required: true type: string format: date-time responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json-seq: id: 8c6bab39-317b-471f-8c6d-9c23649ac548 subscriptionOwnerAccountNumber: A-00000001 invoiceOwnerAccountNumber: A-00000001 subscriptionName: A-S0000001 chargeNumber: C-00000001 ratePlanChargeId: 2c92a00770ec485c01710777ff284f8b productId: 2c92a0f94fded238014ff66557c22724 productRatePlanId: 2c92a0f94fded238014ff6655d9127cc productRatePlanChargeId: 2c92a00770ec485c01710777fe944f82 amendmentId: 2c92a00770ec485c01710777fe944f82 amendmentType: NewProduct startDate: '2020-01-01' endDate: '2020-04-01' mrrGrossAmount: 100.0 mrrNetAmount: 90.0 mrrDiscountAmount: 10.0 tcvGrossAmount: 300.0 tcvNetAmount: 270.0 tcvDiscountAmount: 30.0 currency: USD createdOn: '2020-01-01T00:00:01+00:00' updatedOn: '2020-01-01T00:00:01+00:00' deleted: false schema: $ref: '#/definitions/ChargeMetricsResponse' '400': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: Invalid Parameters schema: $ref: '#/definitions/CommonReasonsErrorResponse' examples: application/json: reasons: - code: '53400020' message: '''toTimestamp'' must be after the ''fromTimestamp''.' '429': description: Rate limited headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Retry-After: type: integer description: 'The interval of seconds that you have to wait before another retry. ' schema: $ref: '#/definitions/CommonReasonsErrorResponse' examples: application/json: reasons: - code: '53400070' message: Only two requests are allowed within any 24-hour window. '500': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: Internal Error schema: $ref: '#/definitions/CommonReasonsErrorResponse' examples: application/json: reasons: - code: '53400060' message: Internal error detected. /charge-metrics/data/charge-metrics-discount-allocation-detail: get: summary: List discount allocation details by time range description: "Retrieves discount allocation details about rate plan charges\ \ that have changes in a specified time range.\n\nThe purpose of `fromTimestamp`\ \ and `toTimestamp` is to synchronize discount allocation details incrementally.\ \ \n" operationId: GET_ChargeMetricsDiscountAllocationDetails tags: - Charge Metrics parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Charge_Metrics_Accept' - name: fromTimestamp description: 'The starting date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example, `2020-08-18T09:01:11Z`. The timestamp maps to the `UpdatedOn` timestamp of the to-be-exported object. ' in: query required: true type: string format: date-time - name: toTimestamp description: 'The end date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example, `2020-08-20T09:01:11Z`. The timestamp maps to the `UpdatedOn` timestamp of the to-be-exported object. ' in: query required: true type: string format: date-time responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ChargeMetricsDiscountAllocationDetailResponse' '400': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: Invalid Parameters schema: $ref: '#/definitions/CommonReasonsErrorResponse' examples: application/json: reasons: - code: '53410020' message: '''toTimestamp'' must be after the ''fromTimestamp''.' '429': description: Rate limited headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Retry-After: type: integer description: 'The interval of seconds that you have to wait before another retry. ' schema: $ref: '#/definitions/CommonReasonsErrorResponse' examples: application/json: reasons: - code: '53410070' message: Only two requests are allowed within any 24-hour window. '500': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: Internal Error schema: $ref: '#/definitions/CommonReasonsErrorResponse' examples: application/json: reasons: - code: '53410060' message: Internal error detected. /v1/charge-revenue-summaries/{crs-number}: get: summary: List all details of a charge revenue summary operationId: GET_CRSByCRSNumber description: 'Retrieves the details of a charge revenue summary by specifying the charge revenue summary number. The response includes all revenue items associated with the charge revenue summary. ' tags: - Charge Revenue Summaries parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: crs-number in: path description: 'The charge revenue summary number. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: number: CRS-00000001 recognitionRuleName: Recognize upon invoicing amount: 660 undistributedUnrecognizedRevenue: 565 recognizedRevenue: 0 unrecognizedRevenue: 660 currency: USD notes: null accountId: 2c92c0f8439770960143b2141f5a555e subscriptionId: 2c92c0f943977b4f0143b23487999327 subscriptionChargeId: 2c92c0f943977b4f0143b11187ed432e revenueItems: - accountingPeriodName: Sep'2013 isAccountingPeriodClosed: false amount: 35 currency: USD accountingPeriodStartDate: '2013-09-01' accountingPeriodEndDate: '2013-09-30' - accountingPeriodName: Oct'2013 isAccountingPeriodClosed: false amount: 50 currency: USD accountingPeriodStartDate: '2013-10-01' accountingPeriodEndDate: '2013-10-31' - accountingPeriodName: Open-Ended isAccountingPeriodClosed: false amount: 150 currency: USD accountingPeriodStartDate: '2013-12-11' accountingPeriodEndDate: null success: true description: '' schema: $ref: '#/definitions/GETChargeRSDetailType' /v1/charge-revenue-summaries/subscription-charges/{charge-key}: get: summary: Retrieve a charge revenue summary by charge ID operationId: GET_CRSByChargeID description: 'Retrieves the details of a charge revenue summary by specifying the subscription charge ID. This response retrieves all revenue items associated with a charge revenue summary. ' tags: - Charge Revenue Summaries parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: charge-key in: path description: 'ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: number: CRS-00000001 recognitionRuleName: Recognize daily over time amount: 428 undistributedUnrecognizedRevenue: 0 recognizedRevenue: 0 unrecognizedRevenue: 428 currency: USD notes: null accountId: 2c92c0f9410f55ee014110a008f6791f subscriptionId: 2c92c0f9410f55dd014110a14aa47f09 subscriptionChargeId: 2c92c0f9410f55dd014110b22cbc023f revenueItems: - accountingPeriodName: May 2012 isAccountingPeriodClosed: false amount: 100 currency: USD accountingPeriodStartDate: '2012-05-01' accountingPeriodEndDate: '2012-05-31' - accountingPeriodName: Jun 2012 isAccountingPeriodClosed: false amount: 92 currency: USD accountingPeriodStartDate: '2012-06-01' accountingPeriodEndDate: '2012-06-30' - accountingPeriodName: Jul 2012 isAccountingPeriodClosed: false amount: 0 currency: USD accountingPeriodStartDate: '2012-07-01' accountingPeriodEndDate: '2012-07-31' - accountingPeriodName: Aug 2012 isAccountingPeriodClosed: false amount: 85 currency: USD accountingPeriodStartDate: '2012-08-01' accountingPeriodEndDate: '2012-08-31' - accountingPeriodName: Sep 2012 isAccountingPeriodClosed: false amount: 85 currency: USD accountingPeriodStartDate: '2012-09-01' accountingPeriodEndDate: '2012-09-30' - accountingPeriodName: Jan'2013 isAccountingPeriodClosed: false amount: 80 currency: USD accountingPeriodStartDate: '2013-01-01' accountingPeriodEndDate: '2013-01-31' - accountingPeriodName: Feb'2013 isAccountingPeriodClosed: false amount: 5 currency: USD accountingPeriodStartDate: '2013-02-01' accountingPeriodEndDate: '2013-02-28' - accountingPeriodName: Sep'2013 isAccountingPeriodClosed: false amount: -7 currency: USD accountingPeriodStartDate: '2013-09-01' accountingPeriodEndDate: '2013-09-30' - accountingPeriodName: Nov'2013 isAccountingPeriodClosed: false amount: -12 currency: USD accountingPeriodStartDate: '2013-11-01' accountingPeriodEndDate: '2013-11-30' - accountingPeriodName: Dec 2013 isAccountingPeriodClosed: false amount: 0 currency: USD accountingPeriodStartDate: '2013-12-11' accountingPeriodEndDate: '2014-01-10' - accountingPeriodName: Open-Ended isAccountingPeriodClosed: false amount: 0 currency: USD accountingPeriodStartDate: '2014-03-12' accountingPeriodEndDate: null success: true description: '' schema: $ref: '#/definitions/GETChargeRSDetailType' /v1/connections: post: summary: Establish a connection to Zuora REST API operationId: POST_Connections description: "Establishes a connection to the Zuora REST API service based on\ \ a valid user credentials. \n\n**Note:**This is a legacy REST API. Zuora\ \ recommends you to use [OAuth](https://developer.zuora.com/rest-api/general-concepts/authentication/)\ \ for authentication instead. \n\nThis call authenticates the user and returns\ \ an API session cookie that's used to authorize subsequent calls to the REST\ \ API. The credentials must belong to a user account that has permission to\ \ access the API service.\n\nAs noted elsewhere, it's strongly recommended\ \ that an account used for Zuora API activity is never used to log into the\ \ Zuora UI. Once an account is used to log into the UI, it may be subject\ \ to periodic forced password changes, which may eventually lead to authentication\ \ failures when using the API.\n" tags: - Connections parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: apiAccessKeyId in: header description: 'Account username ' required: true type: string - name: apiSecretAccessKey in: header description: 'Account password ' required: true type: string - name: Content-Type in: header description: 'Must be set to "application/json" ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' '/v1/object/contact': post: summary: 'CRUD: Create a contact' operationId: Object_POSTContact description: | Creates a contact for a specified account. tags: - Contacts parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: CreateRequest in: body description: "" required: true schema: $ref: '#/definitions/ProxyCreateContact' responses: '200': examples: application/json: { "Success": true, "Id": "2c93808457d787030157e03220684fac" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: { "Errors":[ { "Code": "INVALID_VALUE", "Message": "The account number 123xProxy is invalid." } ], "Success": false } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: { "message": "Authentication error" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' # GET Contact by ID '/v1/object/contact/{id}': get: summary: 'CRUD: Retrieve a contact' operationId: Object_GETContact description: | Retrieves detailed information about a specific contact. tags: - Contacts parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: "Object fields to return" - name: id in: path description: "Object id" required: true type: string responses: '200': examples: application/json: { "OtherPhoneType": "Work", "MobilePhone": "8613312345678", "Id": "2c93808457d787030157e02e606e2095", "FirstName": "FN1476934918260_new", "NickName": "this is nick name", "UpdatedDate": "2016-10-20T05:41:58.000+02:00", "Country": "United States", "WorkEmail": "work@example.com", "HomePhone": "86123456789", "AccountId": "2c93808457d787030157e02e5fde2094", "Description": "desc", "OtherPhone": "11111111111111111", "Fax": "123456", "CreatedById": "2c93808457d787030157e02e45291f18", "CreatedDate": "2016-10-20T05:41:58.000+02:00", "PostalCode": "98119", "UpdatedById": "2c93808457d787030157e02e45291f18", "City": "Seattle", "TaxRegion": "CA", "State": "Washington", "PersonalEmail": "home@example.com", "Address1": "312 2nd Ave W", "LastName": "LN1476934918260" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyGetContact' '401': examples: application/json: { "message": "Authentication error" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: { "records":{}, "size":0, "done":true } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyNoDataResponse' # PUT Contact put: summary: 'CRUD: Update a contact' operationId: Object_PUTContact description: | Updates a contact for a specified account. You can update contacts for cancelled accounts. tags: - Contacts parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: "" required: true schema: $ref: '#/definitions/ProxyModifyContact' responses: '200': examples: application/json: { "Success": true, "Id": "2c93808457d787030157e02e606e2095" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: { "message": "Authentication error" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' # DELETE Contact delete: summary: 'CRUD: Delete a contact' operationId: Object_DELETEContact description: | Deletes a contact. tags: - Contacts parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: { "success": true, "id": "2c93808457d787030157e02e5b26208f" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: { "message": "Authentication error" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/document-properties: post: summary: Create document properties operationId: POST_DocumentProperties description: "**Note:** This feature is available only if you have the Billing\ \ Document Properties Setup feature enabled. The Billing Document Properties\ \ Setup feature is in **Limited Availability**. If you wish to have access\ \ to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n\ \nCreates custom document properties for a billing document. For example,\ \ a document property can be a custom name used for files generated for billing\ \ documents. Billing documents include invoices, credit memos, and debit memos.\n\ \nIf you want to configure custom file names for billing documents created\ \ through API operations, you have to call this operation before posting the\ \ billing documents. \n\n**Note:** You can create document properties for\ \ credit and debit memos only if you have the Invoice Settlement feature enabled.\ \ The Invoice Settlement feature is generally available as of Zuora Billing\ \ Release 296 (March 2021). This feature includes Unapplied Payments, Credit\ \ and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice\ \ Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information.\n" tags: - Document Properties parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTDocumentPropertiesType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true id: 402892c74c9193cd014c96bbe7c101f9 documentKey: 40288af1614cee0b01614cf2ec25000a documentType: CreditMemo customFileName: testCreditMemo description: '' schema: $ref: '#/definitions/GETDocumentPropertiesResponseType' /v1/document-properties/{documentType}/{documentKey}: get: summary: List all properties of a billing document operationId: GET_DocumentProperties description: "**Note:** This feature is available only if you have the Billing\ \ Document Properties Setup feature enabled. The Billing Document Properties\ \ Setup feature is in **Limited Availability**. If you wish to have access\ \ to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n\ \n Retrieve information about document properties of a billing document. Billing\ \ documents include invoices, credit memos, and debit memos.\n \n **Note:**\ \ You can retrieve information about document properties of credit and debit\ \ memos only if you have the Invoice Settlement feature enabled. The Invoice\ \ Settlement feature is generally available as of Zuora Billing Release 296\ \ (March 2021). This feature includes Unapplied Payments, Credit and Debit\ \ Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement,\ \ see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information.\n" tags: - Document Properties parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: documentType in: path description: "The type of the billing document. \n" type: string enum: - Invoice - CreditMemo - DebitMemo required: true - name: documentKey in: path description: 'The unique ID or number of document properties to be retrieved. For example, 402892c74c9193cd014c96bbe7c101f9, INV00000001, CM00000001, or DM00000001. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true id: 402892c74c9193cd014c96bbe7c101f9 documentId: 40288af1614cee0b01614cf2ec25000a documentType: CreditMemo customFileName: customPDFName description: '' schema: $ref: '#/definitions/GETDocumentPropertiesResponseType' /v1/document-properties/{documentPropertiesId}: put: summary: Update document properties operationId: PUT_DocumentProperties description: | **Note:** This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Updates document properties with a specific ID for a billing document. Billing documents include invoices, credit memos, and debit memos. **Note:** You can update document properties for credit and debit memos only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. tags: - Document Properties parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTDocumentPropertiesType' - name: documentPropertiesId in: path description: 'The unique ID of document properties to be updated. For example, 402892c74c9193cd014c96bbe7c101f9. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true id: 402892c74c9193cd014c96bbe7c101f9 documentId: 40288af1614cee0b01614cf2ec25000a documentType: CreditMemo customFileName: customPDFName description: '' schema: $ref: '#/definitions/GETDocumentPropertiesResponseType' delete: summary: Delete document properties operationId: DELETE_DocumentProperties description: | **Note:** This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Deletes document properties with a specific ID for a billing document. Billing documents include invoices, credit memos, and debit memos. **Note:** You can delete document properties for credit and debit memos only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. tags: - Document Properties parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: documentPropertiesId in: path description: 'The unique ID of document properties. For example, 402892c74c9193cd014c96bbe7c101f9. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/hmac-signatures: post: summary: Generate an HMAC signature operationId: POST_HMACSignatures description: 'This REST API reference describes how to return unique signature and token values that used to process a CORS enabled API call. ' tags: - HMAC Signatures parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTHMACSignatureType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: signature: ZmI0ZjE2ZTMxMWY1YjA0ZTc4MTg1ZDhlYWRkMTEwNDE3M2RiMzNiNQ== token: gCH6gYqQffQCsFKSLuxyagXsuXcIK0uf success: true description: '' schema: $ref: '#/definitions/POSTHMACSignatureResponseType' /v1/entities: post: summary: 'Multi-entity: Create an entity' operationId: POST_Entities description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/). \n\nCreates an entity in a multi-entity\ \ hierarchy.\n\n### User Access Permission\nYou must make the call as a global\ \ entity administrator.\n\n### Notes\n* We recommend that you assign only one\ \ administrator to manage the entity hierarchy, because an administrator of\ \ the global entity by default can only access to the entities that are created\ \ by themselves.\n" tags: - Entities parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/CreateEntityType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 8a80825556ff28a4015709096c5d6f5d name: Acme-Asia displayName: Acme-Asia locale: zh_CN timezone: Asia/Harbin status: Unprovisioned parentId: 8a808255557baba1015580e12fa5083a tenantId: '6398' success: true description: '' schema: $ref: '#/definitions/CreateEntityResponseType' get: summary: 'Multi-entity: List entities' operationId: GET_Entities description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/). \n\n\nRetrieves detailed information\ \ of certain entities in a multi-entity hierarchy.\n\n\nYou can retrieve:\n\ \n - Provisioned entities\n \n - Unprovisioned entities\n \n - Both provisioned\ \ and unprovisioned entities\n\n### User Access Permission\n\nYou can make\ \ the call as any entity user.\n" tags: - Entities parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: provisioned in: query description: | Specify whether to retrieve provisioned or unprovisioned entities: - `true`: Provisioned entities - `false`: Unprovisioned entities If you do not specify this field in the request, both the provisioned and unprovisioned entities are returned. required: false type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: entities: - id: 8a808255557baba1015580e12fa5083a name: Acme Corporation displayName: Acme Corporation locale: en_US timezone: GMT status: Provisioned parentId: null tenantId: '6398' - id: 8a80825555a3c7a10155b460f53858e6 name: Acme-Americas displayName: Acme-Americas locale: en_US timezone: America/Los_Angeles status: Provisioned parentId: 8a808255557baba1015580e12fa5083a tenantId: '6398' - id: 8a80825555a3c7a10155b46120d058e7 name: Acme-US displayName: Acme-US locale: en_US timezone: America/Los_Angeles status: Provisioned parentId: 8a80825555a3c7a10155b460f53858e6 tenantId: '6398' - id: 8a80825556ff28a4015708ba29312ecc name: Acme-Europe displayName: Acme-Europe locale: en_US timezone: Europe/Paris status: Provisioned parentId: 8a808255557baba1015580e12fa5083a tenantId: '6398' - id: 8a80825556ff28a4015708bac1d8305f name: Acme-UK displayName: Acme-UK locale: en_US timezone: Europe/London status: Unprovisioned parentId: 8a80825556ff28a4015708ba29312ecc tenantId: '6398' - id: 8a80825556ff28a4015708bb21963060 name: Acme-France displayName: Acme-France locale: en_US timezone: Europe/Paris status: Unprovisioned parentId: 8a80825556ff28a4015708ba29312ecc tenantId: '6398' success: true description: '' schema: $ref: '#/definitions/GETEntitiesResponseType' /v1/entities/{id}: put: summary: 'Multi-entity: Update an entity' operationId: PUT_Entities description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/). \n\nEdits the following information\ \ about an unprovisioned entity:\n\n - Name\n \n - Display name\n \n - Locale\n\ \ \n - Timezone\n\n### User Access Permission\nYou must make the call as a\ \ global entity administrator.\n\n### Notes\n* You are not allowed to edit\ \ the locale and time zone of the provisioned entities through the REST API.\n\ * You are not allowed to edit the display name of the global entity.\n" tags: - Entities parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: id in: path required: true type: string description: The Id of the entity that you want to edit. You can get the entity Id from the GET Entities call. - name: Request in: body description: '' required: true schema: $ref: '#/definitions/UpdateEntityType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/UpdateEntityResponseType' get: summary: 'Multi-entity: Retrieve an entity' operationId: GET_EntityById description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/). \n\nRetrieves detailed information\ \ about a specified entity.\n\n### User Access Permission\nYou can make the\ \ call as any entity user. \n" tags: - Entities parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: id in: path required: true type: string description: Specify the Id of the entity that you want to retrieve. You can get the entity Id from the GET Entities call. responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 8a80825555a3c7a10155b460f53858e6 name: Acme-Americas displayName: Acme-Americas locale: en_US timezone: America/Los_Angeles status: Provisioned parentId: 8a808255557baba1015580e12fa5083a tenantId: '6398' success: true description: '' schema: $ref: '#/definitions/GETEntitiesResponseTypeWithId' delete: summary: 'Multi-entity: Delete an entity' operationId: DELETE_Entities description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/). \n\nRemoves an entity and its sub-entities\ \ from a multi-entity hierarchy. You can only remove unprovisioned entities.\ \ An error occurred when you remove a provisioned entity.\n\n### User Access\ \ Permission\nYou must make the call as a global entity administrator. \n" tags: - Entities parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: id in: path required: true type: string description: Specify the Id of the entity that you want to delete. You can get the entity Id from the GET Entities call. responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/DELETEntityResponseType' /v1/entities/{id}/provision: put: summary: 'Multi-entity: Provision an entity' operationId: PUT_ProvisionEntity description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/). \n\nProvisions an entity. You can only\ \ provision an entity if its parent entity is provisioned.\n\n### User Access\ \ Permission\nYou must make the call as a global entity administrator. \n\n\ ### Notes\n* Zuora does not allow you to remove a provisioned entity from the\ \ multi-entity hierarchy. So before you provision an entity, make sure that\ \ you put the entity in the correct place in the multi-entity hierarchy. \n" tags: - Entities parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: id in: path required: true type: string description: Specify the Id of the entity that you want to provision. You can get the entity Id from the GET Entities call. responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/ProvisionEntityResponseType' /v1/entity-connections: get: summary: 'Multi-entity: List connections' operationId: GET_EntityConnections tags: - Entity Connections description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/).\n\nRetrieves information about certain\ \ connections for a specified entity. You can specify the entity to retrieve\ \ in the `Zuora-Entity-Ids` request header.\n\nYou can retrieve:\n - Inbound\ \ connections\n - Outbound connections\n - Both inbound and outbound connections\n\ \n### User Access Permission\nYou can make the call as any entity user. \n" parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize_entityConnection' - name: type in: query required: false type: string enum: - inbound - outbound description: | Specifies whether to retrieve inbound or outbound connections for an entity. Possible values: - `inbound`: All the incoming connections to the entity. - `outbound`: All the outgoing connections from the entity. If you do not specify this field in the request, both the inbound and outbound connections are returned. responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/GETEntityConnectionsResponseType' examples: application/json: entityConnections: - id: 8a80825555a3c7a10155b54a63821c0d sourceEntityId: 8a80825555a3c7a10155b46120d058e7 targetEntityId: 8a808255557baba1015580e12fa5083a status: Connected - id: 8a80825555a3c7a10155b466736c5c3f sourceEntityId: 8a808255557baba1015580e12fa5083a targetEntityId: 8a80825555a3c7a10155b460f53858e6 status: Connected - id: 8a808255575bdae401576a914a140420 sourceEntityId: 8a808255557baba1015580e12fa5083a targetEntityId: 8a80825556ff28a4015708ba29312ecc status: Connected success: true post: summary: 'Multi-entity: Initiate a connection request' operationId: POST_EntityConnections tags: - Entity Connections description: | **Note:** The Multi-entity feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Initiates a connection request from a source entity to a target entity. ### User Access Permission You must make the call as a source entity administrator. Also, this administrator must have permission to access to the target entity. parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: Request in: body description: '' schema: $ref: '#/definitions/POSTEntityConnectionsType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/POSTEntityConnectionsResponseType' examples: application/json: id: 8a808255575bdae401576a914a140420 success: true /v1/entity-connections/{connection-id}/accept: put: summary: 'Multi-entity: Accept a connection request' operationId: PUT_EntityConnectionsAccept tags: - Entity Connections description: | **Note:** The Multi-entity feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Accepts a connection request. ### User Access Permission You must make the call as an entity administrator to accept a connection request. parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: connection-id in: path required: true type: string description: 'The ID of the connection that you want to accept. ' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/PUTEntityConnectionsAcceptResponseType' examples: application/json: success: true /v1/entity-connections/{connection-id}/deny: put: summary: 'Multi-entity: Deny a connection request' operationId: PUT_EntityConnectionsDeny tags: - Entity Connections description: | **Note:** The Multi-entity feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Denies a connection request. ### User Access Permission You must make the call as an entity administrator to deny a connection request. parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: connection-id in: path required: true type: string description: 'The ID of the connection that you want to deny. ' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/PUTEntityConnectionsDenyResponseType' examples: application/json: success: true /v1/entity-connections/{connection-id}/disconnect: put: summary: 'Multi-entity: Disconnect a connection' operationId: PUT_EntityConnectionsDisconnect tags: - Entity Connections description: | **Note:** The Multi-entity feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Disconnects an established connection. If you have shared objects from a global entity to a target entity, disconnecting the connection will break the mapping relationship between these entities and cannot be recovered later. ### User Access Permission You must make the call as an administrator of the target entity or source entity. parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: connection-id in: path required: true type: string description: 'The ID of the connection that you want to disconnect. ' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/PUTEntityConnectionsDisconnectResponseType' examples: application/json: success: true /v1/users/{username}/request-access: put: summary: 'Multi-entity: Send user access requests' operationId: PUT_SendUserAccessRequests description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/). \n\nSends access requests to the entities\ \ that a user wants to access.\n\n### User Access Permission\nYou must make\ \ the call as an administrator of the entity, in which the request user is\ \ created. Also, this administrator must have the permission to access the\ \ entities that the request user wants to access.\n" tags: - Users parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: username in: path required: true type: string description: 'Specify the login name of the user who wants to access other entities. ' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTSendUserAccessRequestType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/PUTSendUserAccessRequestResponseType' /v1/users/{username}/accept-access: put: summary: 'Multi-entity: Accept user access' operationId: PUT_AcceptUserAccess description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/). \n\nAccepts user access to an entity.\n\ \n### User Access Permission\nYou must make the calls as an administrator of\ \ the entity that you want to accept the user access to. \n" tags: - Users parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: username in: path description: 'Specify the login name of the user that you want to accept the access request for. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/PUTAcceptUserAccessResponseType' /v1/users/{username}/deny-access: put: summary: 'Multi-entity: Deny user access' operationId: PUT_DenyUserAccess description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/). \n\nDenies a user access to an entity.\ \ \n\n### User Access Permission\nYou must make the calls as an administrator\ \ of the entity that you want to deny the user access to.\n" tags: - Users parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: username in: path required: true type: string description: 'Specify the login name of the user that you want to deny the access. ' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/PUTDenyUserAccessResponseType' /v1/users/{username}/accessible-entities: get: summary: 'Multi-entity: List all entities that a user can access' operationId: GET_EntitiesUserAccessible description: "**Note:** The Multi-entity feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at [Zuora Global\ \ Support](http://support.zuora.com/). \n\nRetrieves detailed information\ \ about all the entities that a user has permission to access.\n\n### User\ \ Access Permission\nYou can make the call as any entity user.\n" tags: - Users parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: username in: path required: true type: string description: 'Specify the login user name that you want to retrieve. ' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: entities: - id: 8a808255557baba1015580e12fa5083a name: Acme Corporation displayName: Acme Corporation locale: en_US timezone: GMT status: Provisioned parentId: null tenantId: '6398' - id: 8a80825555a3c7a10155b460f53858e6 name: Acme-Americas displayName: Acme-Americas locale: en_US timezone: America/Los_Angeles status: Provisioned parentId: 8a808255557baba1015580e12fa5083a tenantId: '6398' - id: 8a80825555a3c7a10155b46120d058e7 name: Acme-US displayName: Acme-US locale: en_US timezone: America/Los_Angeles status: Provisioned parentId: 8a80825555a3c7a10155b460f53858e6 tenantId: '6398' - id: 8a80825556ff28a4015708b93df82ba7 name: Acme-Canada displayName: Acme-Canada locale: en_US timezone: America/Toronto status: Provisioned parentId: 8a80825555a3c7a10155b460f53858e6 tenantId: '6398' success: true description: '' schema: $ref: '#/definitions/GETEntitiesUserAccessibleResponseType' /v1/orders/term/{subscriptionNumber}: get: summary: List subscription terms operationId: GET_SubscriptionTermInfo 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. Retrieves the terms of the specified subscription. tags: - Orders parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: subscriptionNumber in: path description: 'The number of the subscription to retrieve terms for. For example, A-S00000001. ' required: true type: string - name: version in: query description: 'The version of the subscription to retrieve terms for. If you do not specify this parameter, Zuora returns the terms for the latest version of the subscription. ' required: false type: integer - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' responses: 200: headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/GetSubscriptionTermInfoResponseType' examples: application/json: success: true nextPage: https://rest.zuora.com/v1/orders/term/A-S00000001?page=2 terms: - termNumber: 1 isEvergreen: false startDate: '2017-11-01' endDate: '2017-12-01' /v1/orders/{orderNumber}/evergreenMetrics/{subscriptionNumber}: get: summary: List order metrics for an evergreen subscription operationId: GET_OrderMetricsforEvergreenSubscription 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.\n\n**Note:** As of Zuora Billing Release\ \ 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders).\ \ The new methodologies are reflected in the following Order Delta Metrics\ \ objects. \n* [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)\n\ * [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)\n\ * [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)\n\ \nIt is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics).\ \ If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders)\ \ customer and want to migrate to Order Delta Metrics, submit a request at\ \ [Zuora Global Support](https://support.zuora.com/).\n\nWhereas new customers,\ \ and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders),\ \ will no longer have access to Order Metrics, existing customers currently\ \ using Order Metrics will continue to be supported.\n\n**Note:** As of Zuora\ \ Billing Release 306, any new customers who onboard on [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)\ \ will no longer get this operation.\n\n\nRetrieves the metrics of an evergreen\ \ subscription in a specified order.\n" tags: - Orders parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: orderNumber in: path description: 'The order number. ' required: true type: string format: string - name: subscriptionNumber in: path description: 'The subscription number you want to get the metrics for. ' required: true type: string - name: startDate in: query description: 'The start date of the date range for which you want to get the metrics. The date must be in yyyy-mm-dd format. For example, 2017-12-03. ' required: true type: string format: date - name: endDate in: query description: 'The end date of the date range for which you want to get the metrics. The date must be in yyyy-mm-dd format. For example, 2017-12-03. ' required: true type: string format: date responses: 200: headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/GetOrderResponseForEvergreen' examples: application/json: success: true order: orderNumber: OR-00015 orderDate: '2017-01-01' createdDate: '2017-08-02' createdBy: 8a8081085d834928015d837c3c4e0037 updatedDate: '2017-08-02' updatedBy: 8a8081085d834928015d837c3c4e0037 existingAccountNumber: A-00002 currency: USD status: Completed description: This is a description for the Order. subscriptions: - subscriptionNumber: S-00004 customFields: {} baseVersion: null newVersion: 1 orderActions: - type: CreateSubscription sequence: 0 triggerDates: - triggerDate: '2017-01-01' name: ServiceActivation - triggerDate: '2017-01-01' name: CustomerAcceptance createSubscription: subscriptionOwnerAccountNumber: null terms: autoRenew: null renewalSetting: null initialTerm: startDate: '2017-01-01' period: null periodType: null termType: EVERGREEN renewalTerms: - period: null periodType: null invoiceSeparately: null notes: null subscribeToRatePlans: - productRatePlanId: 8a8081085d834928015d9c54e67f0aa9 newRatePlanId: 8a8081085d834928015da1e36fdd2061 uniqueToken: Sugar-free Monthly chargeOverrides: - description: null chargeNumber: C-00000015 productRateplanChargeId: 8a8081085d834928015d9c55d45f0aac uniqueToken: Sugar-free Membership Monthly Charge pricing: recurringPerUnit: listPrice: null priceChangeOption: null priceIncreasePercentage: null startDate: specificTriggerDate: null endDate: endDateCondition: null specificEndDate: null upToPeriods: null upToPeriodsType: null billing: billCycleDay: null billingPeriod: null billCycleType: null billingTiming: null billingPeriodAlignment: null specificBillingPeriod: null weeklyBillCycleDay: null customFields: {} customFields: {} customFields: {} orderMetrics: - productRatePlanChargeId: 8a8081085d834928015d9c55d45f0aac originRatePlanId: 8a8081085d834928015da1e36fdd2061 tcb: - subscriptionOwner: A-00002 invoiceOwner: A-00002 amount: 36.129032258 endDate: '2017-02-28' termNumber: 1 tax: 0 type: Regular startDate: '2017-01-07' quantity: - subscriptionOwner: A-00002 invoiceOwner: A-00002 amount: 10 endDate: '2017-02-28' termNumber: 1 startDate: '2017-01-07' productRatePlanId: 8a8081085d834928015da1e36fd9205e tcv: - subscriptionOwner: A-00002 invoiceOwner: A-00002 amount: 35.714285714 endDate: '2017-02-28' termNumber: 1 type: Regular startDate: '2017-01-07' chargeNumber: C-00000015 mrr: - subscriptionOwner: A-00002 invoiceOwner: A-00002 amount: 20 endDate: '2017-02-28' termNumber: 1 type: Regular startDate: '2017-01-07' customFields: {} /v1/payment-gateway-transaction-log/{paymentOrRefundOrPaymentMethod-id}: get: summary: Retrieve a payment gateway transaction log operationId: GET_PaymentGatewayTransactionLog description: 'Retrieves transaction log information passed through your [custom payment gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods). ' tags: - Payment Gateway Transaction Logs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: paymentOrRefundOrPaymentMethod-id in: path required: true type: string description: 'The ID of a payment, a refund, or a payment method wherein the gateway transaction log was recorded. ' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true data: - createdBy: 402881e522cf4f9b0122cf5d82860002 updatedBy: 402881e522cf4f9b0122cf5d82860002 createTime: 08/10/2021, 15:56:33 updateTime: 08/10/2021, 15:57:13 id: 402880e77c5ebd66017c5f70b2a300ac tenantId: '9' gatewayType: Adyen gatewayVersion: '2' gatewayId: 402880e77c5ebd66017c5ef007d8003b gatewayName: Adyen test V2 paymentMethodType: CreditCard operationType: Payment currency: USD operationId: ee9acc9cbbdb41e0874357743e0ef96f zReferenceId: 402880e77c5ebd66017c5f70ad2e00aa responseCode: Error sendTime: 08/10/2021, 15:56:32 receiveTime: 08/10/2021, 15:57:12 request: "EnableIdempotency=, IdempotencyKey=, Request = [{\n \ \ \"billingAddress\": {\n \ \ \"country\": \"IN\"\n }, \n\ \ \"amount\": {\n \"currency\":\ \ \"USD\",\n \"value\": 57419\n \ \ },\n \"merchantAccount\": \"ZuoraCOM\",\n \ \ \"paymentMethod\": {\n \"number\":\ \ \"111111******1111\",\n \"expiryMonth\": \"10\"\ ,\n \"expiryYear\": \"2030\",\n \ \ \"holderName\": \"Ankit\",\n \"type\": \"scheme\"\ \n },\n \"reference\": \"P-00000001\"\ ,\n \"captureDelayHours\": 0,\n \"\ recurring\": {\n \"contract\": \"ONECLICK,RECURRING\"\ \n },\n \"recurringProcessingModel\"\ : \"CardOnFile\", \"shopperInteraction\": \"ContAuth\"\ , \ \ \"shopperReference\": \"A00000001111111\"\ ,\n \n \"applicationInfo\"\ \ : {\n \"externalPlatform\": {\n \ \ \"name\": \"Zuora\",\n \"version\": \"\ OPG\"\n }\n }\n }],\ \ url = [https://checkout-test.adyen.com/v49/payments]" response: 'response_body={"status":422,"errorCode":"133","message":"Required field ''billingAddress.houseNumberOrName'' is not provided.","errorType":"validation"}, shopperReference=, networkTxReference=, ' description: '' schema: $ref: '#/definitions/GETPaymentGatewayTransactionLogResponse' /v1/payment-methods/credit-cards: post: summary: Create a credit card payment method operationId: POST_PaymentMethodsCreditCard description: "**Note: This legacy API operation is no longer under active development.\ \ For more features, it is strongly recommended to use the [Create a payment\ \ method](https://developer.zuora.com/api-references/api/operation/POST_PaymentMethods)\ \ operation.**\n\nYou can create a credit card payment method for a customer\ \ account or an orphan credit card payment method that is not associated with\ \ any customer account. The orphan payment method must be associated with\ \ a customer account within 10 days. Otherwise, it will be deleted.\n\nThis\ \ API call is CORS Enabled. Use client-side JavaScript to invoke the call.\ \ \n\nIf you use this operation to create credit card payment methods instead\ \ of using the [iFrame of Hosted Payment Pages](https://knowledgecenter.zuora.com/CB_Billing/LA_Hosted_Payment_Pages/C_Hosted_Payment_Pages/B_Implementing_Hosted_Payment_Pages_on_Your_Website/C_Embed_and_Submit_the_iFrame),\ \ you are subject to PCI-compliance audit requirements.\n" tags: - Payment Methods parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTPaymentMethodType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: paymentMethodId: 2c92c8f83dcbd8b1013dcce1d6a60 success: true description: '' schema: $ref: '#/definitions/POSTPaymentMethodResponseType' /v1/payment-methods/credit-cards/{payment-method-id}: put: summary: Update a credit card payment method operationId: PUT_PaymentMethodsCreditCard description: 'Updates an existing credit card payment method. ' tags: - Payment Methods parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: payment-method-id in: path required: true type: string description: Unique ID of the payment method to update. - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTPaymentMethodType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: paymentMethodId: 2c92c8f83dcbd8b1013dcce1d6a600ce success: true description: '' schema: $ref: '#/definitions/PUTPaymentMethodResponseType' /v1/payment-methods/credit-cards/accounts/{account-key}: get: summary: List all credit card payment methods of an account operationId: GET_PaymentMethodsCreditCard description: "This REST API reference describes how to retrieve all credit card\n\ information for the specified customer account. \n\n### Notes\nThe response\ \ includes details of credit or debit cards for the specified customer account.\ \ Card numbers are masked. For example:\n```\n************1234\n```\n\nThough\ \ you can also send requests for bank transfer, ACH, or other supported payment\ \ methods, the response will not include effective details of these payment\ \ methods.\n" tags: - Payment Methods parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' - name: account-key in: path description: Account number or account ID. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: nextPage: https://rest.zuora.com/v1/payment-methods/credit-cards/accounts/A00001115?page=2&pageSize=2 creditCards: - cardHolderInfo: zipCode: null addressLine2: null addressLine1: null phone: '4082021111' state: null country: null city: null cardHolderName: Leo email: smith@example.com defaultPaymentMethod: true id: 2c92c8f83dabf9cf013daef12dd303b0 expirationMonth: 10 cardNumber: '************1111' expirationYear: 2020 cardType: Visa - cardHolderInfo: zipCode: '95135' addressLine2: null addressLine1: 1400 Bridge Pkwy phone: null state: California country: United States city: San Jose cardHolderName: foo CC name email: null defaultPaymentMethod: false id: 2c92a0f9391832b10139183e279e0044 expirationMonth: 10 cardNumber: '*****foo CC #' expirationYear: 2012 cardType: Visa success: true description: '' schema: $ref: '#/definitions/GETPaymentMethodsType' /v1/quotes/document: post: summary: Generate a quote document operationId: POST_QuotesDocument description: "The `document` call generates a quote document and returns the\ \ generated document URL. You can directly access the generated quote file\ \ through the returned URL.\n\nThe `document` call should be only used from\ \ Zuora Quotes. \n\n### File Size Limitation \nThe maximum export file size\ \ is 2047MB. If you have large data requests that go over this limit, you\ \ will get the following 403 HTTP response code from Zuora:\n`security:max-object-size>2047MB`\n\ \nSubmit a request at [Zuora Global Support](http://support.zuora.com/) if\ \ you require additional assistance.\n\nWe can work with you to determine\ \ if large file optimization is an option for you.\n" tags: - Quotes Document parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTQuoteDocType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true file: https://rest.zuora.com/v1/file/2c92c09447f1ca410147f7bfed8c5a87 description: '' schema: $ref: '#/definitions/POSTQuoteDocResponseType' /reporting/api/rest/v1/reportruns/{reportRunId}: get: operationId: GET_ReportRun summary: Retrieve a report run description: | Retrieves details of the specific report run. tags: - Reporting parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: reportRunId in: path required: true type: string description: | The ID of the report run. You can get the ID from the JSON response to Run a Report. responses: '200': description: OK headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/GetReportRunResponse' examples: application/json: { "success": true, "response": { "reportType": "Detail", "id": "ff808081529f4e3401529fd61f080074", "reportId": "ff808081529f4e3401529fd373730070", "startedOn": 1453166692000, "status": "COMPLETED", "reportDefinition": "...", "updatedOn": 1453166695000 } } delete: operationId: Delete_ReportRun summary: Cancel a report run description: | Stops the specified report run. tags: - Reporting parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: reportRunId in: path required: true type: string description: | The unique identifier for a report run. You can get the reportRunId from the `id` value in the JSON response to Run a Report. responses: '200': description: OK headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. examples: application/json: { "success" : true, "response" : "The report run has been canceled" } /reporting/api/rest/v1/reports/{ReportId}/reportrun: post: operationId: POST_ReportRun summary: Run a report description: | Starts a new report run and returns the ID of the report run. tags: - Reporting parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: ReportId in: path required: true type: string description: | The unique identifier for a report. You can obtain the ReportId from the `id` value in the JSON response to a call of **Search by Report Names** or you can get it definitively from the response to the **Create a Report** call. - name: viewType in: query required: true type: string description: | The value of viewType must be either **Detail** or **Summary** depending on the report definition. responses: '200': description: OK headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. examples: application/json: { "success": true, "response": { "reportRunId": "ff808081529f4e3401529fd61f080074" } } /reporting/api/rest/v1/reports/search: get: operationId: GET_ReportsByName summary: Search reports by name description: | Retrieves all reports that match a query based on the report name, description, or data source name. Reports are not required to have unique names or descriptions and so this search will typically return many report matches because of matches from multiple fields unless you specify a unique query keyword. Optionally you can specify sorting on either the `name` or the `updated_on` fields. The search is automatically limited to the first 50 results. If you want to query for the next 50, you have to set the `searchStart` parameter to 50 and submit another request to get the next 50 results. tags: - Reporting parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: query in: query required: true type: string description: | The query parameter value sets the search string used to search through all report names, data source names, and descriptions. The value `{string}` can be any alpha-numeric string like: `MyReport1`. * Search is not case-sensitive. * Spaces in the query parameter must be replaced by %20. * Words smaller than three letters are excluded from matching. * Search results include matches from any position in the word. For example, if the search term is "count", the search results will include words such as "counted," "account," and "accounts." - name: orderBy in: query required: false type: string description: | Sorts the results by `name` or `updated_on` value. The value of the `orderBy` statement request path parameter must match the following syntax exactly: `[{"field": "updated_on", "ascend": "true"}]` Where the value of field can be either "name" or "updated_on" and the value of ascend is either "true" or "false." - name: searchStart in: query required: false type: string description: | Skips and excludes a specified number of reports from the query. - name: namespace in: query required: false type: string description: | Specifies whether to use Search by Report Name with Insights Analysis. Set this parameter to ADVANCED to use Search by Report Name with Insights Analysis. Contact [Zuora Global Support](https://support.zuora.com) if you would like to use the Reporting API with Insights Analysis. responses: '200': description: OK headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. examples: application/json: { "success": true, "response": { "reports": [ { "createdBy": "2c92c0f956bc8fcb0156f8eee04b4d54", "updatedBy": "2c92c0f956bc8fcb0156f8eee04b4d54", "createdOn": "2018-04-13T01:52:10+0000", "updatedOn": "2018-04-13T01:52:10+0000", "id": "ff8080816293d35b0162bcb3e7780a75", "deleted": false, "name": "Customer report", "number": "REP0000007", "type": "Common", "datasource": "Account", "dsName": "Account", "namespace": "BASIC", "definition": "...", "userId": "2c92c0f956bc8fcb0156f8eee04b4d54", "creator": "user@example.com", "updater": "user@example.com", "favorite": false, "shared": true, "zuora": false, "hidden": false } ], "count": 1 } } /reporting/api/rest/v1/reports/{reportId}/reportruns/latest: get: operationId: GET_LatestReportRun summary: Retrieve the last completed report run description: | Retieves the ID of the last completed run of a report by the current user in the last 60 days. tags: - Reporting parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: reportId in: path required: true type: string description: | The ID of the report. You can get the reportID from the JSON response to Search by Report Names. responses: '200': description: OK headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. examples: application/json: { "success": true, "response": { "reportType": "Detail", "id": "ff808081529f4e3401529fd61f080074", "reportId": "ff808081529f4e3401529fd373730070", "startedOn": 1453166692000, "status": "COMPLETED", "reportDefinition": "...", "updatedOn": 1453166695000 } } /reporting/api/rest/v1/reportruns/reportdata/{ReportRunId}: get: operationId: GET_ReportData summary: Retrieve report data description: | Returns the report run results for the specified report run. tags: - Reporting parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: ReportRunId in: path required: true type: string description: | The unique identifier for a report run. You can get the ReportRunId from the `id` value in the JSON response to Run a Report or get it from the response to the Get Last Completed Run call. - name: offset in: query required: true type: integer description: | Offset is usually set to a value of 1 to skip the header row. When implementing multiple pages of report result data, the value of offset becomes multiples of the pageSize to omit results displayed on previous pages. - name: pageSize in: query required: true type: integer description: | Sets the number of records that will be retrieved by the GET call. responses: '200': description: OK headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. examples: application/json: { "success" : true, "response" : { "page" : [ { "Invoice.CreatedDate" : "Dec 7, 2013 2:18:00 PM", "Account.Currency" : "USD", "Invoice.Amount" : "900.00", "BillToContact.AccountId" : "2c90838f42cf16030142cf215ecb0014" }, { "Invoice.CreatedDate" : "Nov 7, 2013 11:20:00 AM", "Account.Currency" : "USD", "Invoice.Amount" : "400.00", "BillToContact.AccountId" : "402892f9423062950142308c64e503f3" }, { "Invoice.CreatedDate" : "Jan 20, 2014 3:19:01 PM", "Account.Currency" : "EUR", "Invoice.Amount" : "984.00", "BillToContact.AccountId" : "8a858290439c517a0143b1edf32800ba" }, { "Invoice.CreatedDate" : "Jan 20, 2014 3:24:00 PM", "Account.Currency" : "CAD", "Invoice.Amount" : "1,729.76", "BillToContact.AccountId" : "8a858290439c517a0143b1f4229c013f" } ], "size" : 100, "offset" : 1, "total" : 4 } } /reporting/api/rest/v1/reportruns/export/{ReportRunId}: get: operationId: GET_ExportReportRun summary: Export results of a report run description: | Retrieves report run results as comma separated values. tags: - Reporting parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: ReportRunId in: path required: true type: string description: | The unique identifier for a report run. You can get the ReportRunId from the `id` value in the JSON response to Run a Report or get it from the response to the Get Last Completed Run call. - name: pivoted in: query required: true type: boolean description: | Specifies the layout of summary report results. This parameter does not affect detail report results. * If `true`, the rows and columns in the CSV file are grouped in the same way as the report results displayed in the Zuora user interface. * If `false` (default), the CSV file is formatted as a flat table. responses: '200': description: OK headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. examples: text/csv: > Account: Currency,Account: Name,SUM of 'Account: Account Balance' EUR,East Inc,-120.2 USD,North Services,1,430.5 USD,West Corp,279.75 /v1/revenue-events/{event-number}: get: summary: Retrieve a revenue event operationId: GET_RevenueEventDetails description: 'This REST API reference describes how to get revenue event details by specifying the revenue event number. Request and response field descriptions and sample code are provided. ' tags: - Revenue Events parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: event-number in: path description: The number associated with the revenue event. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: number: RE-00000001 currency: USD notes: null accountId: 2c92c0f8439770960143b2141f5a584e subscriptionId: 2c92c0f943977b4f0143b23487994327 subscriptionChargeId: 2c92c0f943977b4f0143b23487ed432e createdOn: '2014-01-20 16:36:45' eventType: Invoice Posted recognitionStart: '2013-10-10' recognitionEnd: '2013-10-10' revenueItems: - accountingPeriodName: Oct'2013 isAccountingPeriodClosed: false amount: 50 currency: USD accountingPeriodStartDate: '2013-10-01' accountingPeriodEndDate: '2013-10-31' success: true description: '' schema: $ref: '#/definitions/GETRevenueEventDetailType' /v1/revenue-events/revenue-schedules/{rs-number}: get: summary: List all revenue events of a revenue schedule operationId: GET_RevenueEventForRevenueSchedule description: |2 This REST API reference describes how to get all revenue events in a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. tags: - Revenue Events parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize_finance_revenue' - name: rs-number in: path description: Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueEventDetails: - number: RE-00000001 currency: USD notes: Phase 1 Test accountId: 2c92c0f8439770960143b2111f5a584e subscriptionId: 2c92c0f943977b4f0143b23487999327 subscriptionChargeId: 2c92c0f943977b4f0143b22287ed432e createdOn: '2014-01-21 11:35:42' eventType: Revenue Distributed recognitionStart: null recognitionEnd: null revenueItems: - accountingPeriodName: Oct'2013 isAccountingPeriodClosed: false amount: 10 currency: USD accountingPeriodStartDate: '2013-10-01' accountingPeriodEndDate: '2013-10-31' - accountingPeriodName: Open-Ended isAccountingPeriodClosed: false amount: -10 currency: USD accountingPeriodStartDate: '2013-11-12' accountingPeriodEndDate: null - number: RE-00000002 currency: USD notes: null accountId: 2c92c0f8439770960143b2111f5a584e subscriptionId: 2c92c0f943977b4f0143b22287994327 subscriptionChargeId: 2c92c0f943977b4f0143b99987ed432e createdOn: '2014-01-20 16:36:45' eventType: Invoice Posted recognitionStart: '2013-10-10' recognitionEnd: '2013-10-10' revenueItems: - accountingPeriodName: Oct'2013 isAccountingPeriodClosed: false amount: 50 currency: USD accountingPeriodStartDate: '2013-10-01' accountingPeriodEndDate: '2013-10-31' success: true description: '' schema: $ref: '#/definitions/GETRevenueEventDetailsType' /v1/revenue-items/charge-revenue-summaries/{crs-number}: get: summary: List revenue items by charge revenue summary number operationId: GET_RevenueItemsByChargeRevenueSummaryNumber description: 'This REST API reference describes how to get the details for each revenue item in a charge revenue summary by specifying the charge revenue summary number. Request and response field descriptions and sample code are provided. ' tags: - Revenue Items parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize_finance_accounting' - name: crs-number in: path description: The charge revenue summary number. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueItems: - accountingPeriodName: Sep'2013 isAccountingPeriodClosed: false amount: 35 currency: USD accountingPeriodStartDate: '2013-09-01' accountingPeriodEndDate: '2013-09-30' - accountingPeriodName: Oct'2013 isAccountingPeriodClosed: false amount: 50 currency: USD accountingPeriodStartDate: '2013-10-01' accountingPeriodEndDate: '2013-10-31' - accountingPeriodName: Open-Ended isAccountingPeriodClosed: false amount: 150 currency: USD accountingPeriodStartDate: '2013-12-11' accountingPeriodEndDate: null success: true description: '' schema: $ref: '#/definitions/GETRevenueItemsType' /v1/revenue-items/revenue-events/{event-number}: get: summary: List revenue items by revenue event number operationId: GET_RevenueItemsByChargeRevenueEventNumber description: 'This REST API reference describes how to get the details of each revenue item in a revenue event by specifying the revenue event number. Request and response field descriptions and sample code are provided. ' tags: - Revenue Items parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize_finance_accounting' - name: event-number in: path required: true type: string description: The number associated with the revenue event. responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueItems: - accountingPeriodName: Oct'2013 isAccountingPeriodClosed: false amount: 50 currency: USD accountingPeriodStartDate: '2013-10-01' accountingPeriodEndDate: '2013-10-31' success: true description: '' schema: $ref: '#/definitions/GETRevenueItemsType' put: summary: Update custom fields on revenue items by revenue event number operationId: PUT_CustomFieldsonRevenueItemsByRevenueEvent description: 'This REST API reference describes how to update custom fields on revenue items by specifying the revenue event number. Request and response field descriptions and sample code are provided. ' tags: - Revenue Items parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: event-number in: path required: true type: string description: The number associated with the revenue event. - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTEventRIDetailType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/revenue-items/revenue-schedules/{rs-number}: get: summary: List all revenue items of a revenue schedule operationId: GET_RevenueItemsByRevenueSchedule description: 'This REST API reference describes how to get the details for each revenue items in a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. ' tags: - Revenue Items parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize_finance_accounting' - name: rs-number in: path required: true type: string description: Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueItems: - accountingPeriodName: Oct'2013 isAccountingPeriodClosed: false amount: 50 currency: USD accountingPeriodStartDate: '2013-10-01' accountingPeriodEndDate: '2013-10-31' recognizedRevenueAccountingCodeType: null recognizedRevenueAccountingCode: null deferredRevenueAccountingCodeType: null deferredRevenueAccountingCode: null success: true description: '' schema: $ref: '#/definitions/GETRsRevenueItemsType' put: summary: Update custom fields on revenue items by revenue schedule number operationId: PUT_CustomFieldsonRevenueItemsByRevenueSchedule description: 'This REST API reference describes how to update custom fields on revenue Items by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. ' tags: - Revenue Items parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: rs-number in: path required: true type: string description: Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTScheduleRIDetailType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/revenue-recognition-rules/product-charges/{charge-key}: 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. \n\nRetrieves the revenue recognition rule associated\ \ with a production rate plan charge by specifying the charge ID.\n" summary: Retrieve a revenue recognition rule by product rate plan charge ID operationId: GET_RevenueRecRulebyProductRatePlanCharge tags: - Revenue Rules responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: revenueRecognitionRuleName: Custom - Unlimited recognition success: true schema: $ref: '#/definitions/GETRevenueRecognitionRuleAssociationType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - type: string in: path name: charge-key description: 'The unique ID of a product rate plan charge. For example, 8a8082e65ba86084015bb323d3c61d82. ' required: true /v1/revenue-recognition-rules/subscription-charges/{charge-key}: get: summary: Retrieve a revenue recognition rule by subscription charge ID operationId: GET_RevenueRecRules description: 'Retrieves the revenue recognition rule associated with a subscription charge by specifying the charge ID. Request and response field descriptions and sample code are provided. ' tags: - Revenue Rules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: charge-key in: path description: 'The unique ID of the subscription rate plan charge. For example, 402892793e173340013e173b81000012. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueRecognitionRuleName: Recognize upon invoicing success: true description: '' schema: $ref: '#/definitions/GETRevenueRecognitionRuleAssociationType' /v1/settings/finance/revenue-automation-start-date: get: summary: Retrieve a revenue automation start date operationId: GET_RevenueAutomationStartDate description: 'Describes how to get the revenue automation start date. Request and response field descriptions and sample code are provided. ' tags: - Revenue Rules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: startDate: '2012-02-01' updatedOn: '2013-09-11 22:49:18' updatedBy: MyCorpAdmin success: true description: '' schema: $ref: '#/definitions/GETRevenueStartDateSettingType' /v1/revenue-schedules/credit-memo-items/{cmi-id}: 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 revenue schedule for a credit memo item, and manually distribute the revenue. summary: 'Create a revenue schedule for a credit memo item (manual distribution) ' operationId: POST_RSforCreditMemoItem_ManualDistribution tags: - Revenue Schedules responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true revenueScheduleNumber: RS-00000119 schema: $ref: '#/definitions/POSTRevenueScheduleByTransactionResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - type: string in: path name: cmi-id description: 'The unique ID of a credit memo item. You can get the credit memo item ID from the response of [Get credit memo items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems). ' required: true - name: body in: body description: '' required: true schema: $ref: '#/definitions/POSTCmiRevenueScheduleByTransactionType' 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 details about a revenue schedule by specifying a valid credit memo item ID. summary: 'Retrieve a revenue schedule by credit memo item ID ' operationId: GET_RSbyCreditMemoItem tags: - Revenue Schedules responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: number: RS-00000116 recognitionRuleName: Recognize upon invoicing amount: -100 undistributedUnrecognizedRevenue: 0 recognizedRevenue: 0 unrecognizedRevenue: -100 currency: USD notes: null createdOn: '2017-03-03 08:52:59' updatedOn: '2017-03-03 08:53:00' accountId: 2c90838f42cf16030142cf215ecb0014 subscriptionId: 4028903b5a7eb9bc015a91a744a90111 subscriptionChargeId: 4028903b5a7eb9bc015a91a744a90222 productChargeId: 4028903b5a7eb9bc015a91a744a90165 linkedTransactionId: 4028903b5a7eb9bc015a91a7bb380171 linkedTransactionNumber: CM00000001 linkedTransactionType: CreditMemoItem referenceId: null revenueScheduleDate: '2017-03-03' revenueItems: - accountingPeriodName: Mar-2017 isAccountingPeriodClosed: false amount: -100 currency: USD accountingPeriodStartDate: '2017-03-01' accountingPeriodEndDate: '2017-03-31' recognizedRevenueAccountingCodeType: Sales Revenue recognizedRevenueAccountingCode: Subscription Revenue deferredRevenueAccountingCodeType: Deferred Revenue deferredRevenueAccountingCode: Deferred Revenue success: true schema: $ref: '#/definitions/GETRSDetailType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - type: string in: path name: cmi-id description: 'The unique ID of a credit memo item. You can get the credit memo item ID from the response of [Get credit memo items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems). ' required: true /v1/revenue-schedules/credit-memo-items/{cmi-id}/distribute-revenue-with-date-range: 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 revenue schedule for a credit memo item, and automatically distribute the revenue by specifying the recognition start and end dates. summary: 'Create a revenue schedule for a credit memo item (distribute by date range) ' operationId: POST_RSforCreditMemoItem_DistributeByDateRange tags: - Revenue Schedules responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true revenueScheduleNumber: RS-00000119 schema: $ref: '#/definitions/POSTRevenueScheduleByTransactionResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - type: string in: path name: cmi-id description: 'The unique ID of a credit memo item. You can get the credit memo item ID from the response of [Get credit memo items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems). ' required: true - name: body in: body description: '' required: true schema: $ref: '#/definitions/POSTRevenueScheduleByTransactionRatablyCMType' /v1/revenue-schedules/debit-memo-items/{dmi-id}: 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 revenue schedule for a debit memo item, and manually distribute the revenue. summary: 'Create a revenue schedule for a debit memo item (manual distribution) ' operationId: POST_RSforDebitMemoItem_ManualDistribution tags: - Revenue Schedules responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true revenueScheduleNumber: RS-00000119 schema: $ref: '#/definitions/POSTRevenueScheduleByTransactionResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - type: string in: path name: dmi-id description: 'The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems). ' required: true - name: body in: body description: '' required: true schema: $ref: '#/definitions/POSTDmiRevenueScheduleByTransactionType' 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 details about a revenue schedule by specifying a valid debit memo item ID. summary: 'Retrieve a revenue schedule by debit memo item ID ' operationId: GET_RSbyDebitMemoItem tags: - Revenue Schedules responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: number: RS-00000117 recognitionRuleName: Recognize upon invoicing amount: -100 undistributedUnrecognizedRevenue: 0 recognizedRevenue: 0 unrecognizedRevenue: -100 currency: USD notes: null createdOn: '2017-03-03 08:52:59' updatedOn: '2017-03-03 08:53:00' accountId: 2c90838f42cf16030142cf215ecb0014 subscriptionId: 4028903b5a7eb9bc015a91a744a30111 subscriptionChargeId: 4028903b5a7eb9bc015a91a344a90222 productChargeId: 4028903b5a7eb9bc015a91a734a90165 linkedTransactionId: 4028903b5a7eb9bc015a33a7bb380171 linkedTransactionNumber: DM00000001 linkedTransactionType: DebitMemoItem referenceId: null revenueScheduleDate: '2017-03-03' revenueItems: - accountingPeriodName: Mar-2017 isAccountingPeriodClosed: false amount: -100 currency: USD accountingPeriodStartDate: '2017-03-01' accountingPeriodEndDate: '2017-03-31' recognizedRevenueAccountingCodeType: Sales Revenue recognizedRevenueAccountingCode: Subscription Revenue deferredRevenueAccountingCodeType: Deferred Revenue deferredRevenueAccountingCode: Deferred Revenue success: true schema: $ref: '#/definitions/GETRSDetailType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - type: string in: path name: dmi-id description: 'The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems). ' required: true /v1/revenue-schedules/debit-memo-items/{dmi-id}/distribute-revenue-with-date-range: 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 revenue schedule for a debit memo item, and automatically distribute the revenue by specifying the recognition start and end dates. summary: 'Create a revenue schedule for a debit memo item (distribute by date range) ' operationId: POST_RSforDebitMemoItem_DistributeByDateRange tags: - Revenue Schedules responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true revenueScheduleNumber: RS-00000119 schema: $ref: '#/definitions/POSTRevenueScheduleByTransactionResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - type: string in: path name: dmi-id description: 'The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems). ' required: true - name: body in: body description: '' required: true schema: $ref: '#/definitions/POSTRevenueScheduleByTransactionRatablyDMType' /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}: get: summary: Retrieve a revenue schedule by invoice item adjustment key operationId: GET_RSbyInvoiceItemAdjustment description: 'Retrieves the details of a revenue schedule by specifying a valid invoice item adjustment identifier. Request and response field descriptions and sample code are provided. ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: invoice-item-adj-key in: path required: true type: string description: ID of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72. responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: number: RS-00000273 recognitionRuleName: Recognize upon invoicing amount: -25 undistributedUnrecognizedRevenue: -25 recognizedRevenue: 0 unrecognizedRevenue: -25 currency: USD notes: null createdOn: '2014-01-21 13:52:38' updatedOn: '2014-01-21 13:52:38' accountId: 2c92c0f8439770960143b2141f5a584e subscriptionId: 2c92c0f943977b4f0143b23487994327 subscriptionChargeId: 2c92c0f943977b4f0143b23487ed432e linkedTransactionId: 2c92c0f8439770a40143b6ca76df205a linkedTransactionNumber: IIA-00000070 linkedTransactionType: InvoiceItemAdjustment referenceId: null revenueScheduleDate: '2014-01-21' revenueItems: - accountingPeriodName: Open-Ended isAccountingPeriodClosed: false amount: -25 currency: USD accountingPeriodStartDate: '2013-12-11' accountingPeriodEndDate: null recognizedRevenueAccountingCodeType: null recognizedRevenueAccountingCode: null deferredRevenueAccountingCodeType: null deferredRevenueAccountingCode: null success: true description: '' schema: $ref: '#/definitions/GETRSDetailType' post: summary: Create a revenue schedule for an invoice item adjustment (manual distribution) operationId: POST_RSforInvoiceItemAdjustment_ManualDistribution description: 'Creates a revenue schedule for an Invoice Item Adjustment and manually distribute the revenue. ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: invoice-item-adj-key in: path description: | ID or number of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72. If the specified Invoice Item Adjustment is already associated with a revenue schedule, the call will fail. required: true type: string - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTIiaRevenueScheduleByTransactionType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueScheduleNumber: rs-00000002 success: true description: '' schema: $ref: '#/definitions/POSTRevenueScheduleByTransactionResponseType' /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}/distribute-revenue-with-date-range: post: summary: Create a revenue schedule for an invoice item adjustment (distribute by date range) operationId: POST_RSforInvoiceItemAdjustment_DistributeByDateRange description: 'Creates a revenue schedule for an Invoice Item Adjustment and distribute the revenue by specifying the recognition start and end dates. ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: invoice-item-adj-key in: path description: | ID or number of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72. If the specified Invoice Item Adjustment is already associated with a revenue schedule, the call will fail. required: true type: string - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTIiaRevenueScheduleByDateRangeType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueScheduleNumber: RS-00000003 success: true description: '' schema: $ref: '#/definitions/POSTRevenueScheduleByTransactionResponseType' /v1/revenue-schedules/invoice-items/{invoice-item-id}: post: summary: Create a revenue schedule for an invoice item (manual distribution) operationId: POST_RSforInvoiceItem_ManualDistribution description: 'Creates a revenue schedule for an Invoice Item and manually distribute the revenue. ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: invoice-item-id in: path description: | ID of the Invoice Item, for example, e20b07fd416dcfcf0141c81164fd0a75. If the specified Invoice Item is already associated with a revenue schedule, the call will fail. required: true type: string - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTRevenueScheduleByTransactionType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueScheduleNumber: RS-00000002 success: true description: '' schema: $ref: '#/definitions/POSTRevenueScheduleByTransactionResponseType' get: summary: Retrieve a revenue schedule by invoice item ID operationId: GET_RSbyInvoiceItem description: 'Retrieves the details of a revenue schedule by specifying the invoice item ID. ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: invoice-item-id in: path description: A valid Invoice Item ID. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: number: RS-00000290 recognitionRuleName: Recognize upon invoicing amount: 50 undistributedUnrecognizedRevenue: 50 recognizedRevenue: 0 unrecognizedRevenue: 50 currency: USD notes: null createdOn: '2014-01-21 13:59:25' updatedOn: '2014-01-21 13:59:25' accountId: 2c92c0f8439770960143b2141f5a584e subscriptionId: 2c92c0f943977b4f0143b23487994327 subscriptionChargeId: 2c92c0f943977b4f0143b23487ed432e linkedTransactionId: 2c92c094439782460143b62c2ee60f59 linkedTransactionType: InvoiceItem referenceId: null revenueScheduleDate: '2014-01-21' revenueItems: - accountingPeriodName: Open-Ended isAccountingPeriodClosed: false amount: 50 currency: USD accountingPeriodStartDate: '2013-12-11' accountingPeriodEndDate: null recognizedRevenueAccountingCodeType: 'Revenue: Sales' recognizedRevenueAccountingCode: Recurring Monthly Revenue deferredRevenueAccountingCodeType: null deferredRevenueAccountingCode: null success: true description: '' schema: $ref: '#/definitions/GETRSDetailType' /v1/revenue-schedules/invoice-items/{invoice-item-id}/distribute-revenue-with-date-range: post: summary: Create a revenue schedule for an invoice item (distribute by date range) operationId: POST_RSforInvoiceItem_DistributeByDateRange description: 'Creates a revenue schedule for an Invoice Item and distribute the revenue by specifying the recognition start and end dates. ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: invoice-item-id in: path description: | ID of the Invoice Item, for example, e20b07fd416dcfcf0141c81164fd0a75. If the specified Invoice Item is already associated with a revenue schedule, the call will fail. required: true type: string - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTRevenueScheduleByDateRangeType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueScheduleNumber: RS-00000003 success: true description: '' schema: $ref: '#/definitions/POSTRevenueScheduleByTransactionResponseType' /v1/revenue-schedules/product-charges/{charge-key}/{account-key}: 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 details about all revenue schedules of a product rate plan charge by specifying the charge ID and billing account ID. summary: 'List revenue schedules of a product charge by charge ID and account key ' operationId: GET_RSbyProductChargeAndBillingAccount tags: - Revenue Schedules responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: revenueSchedules: - number: RS-00000123 recognitionRuleName: Custom - Unlimited recognition amount: 100 undistributedUnrecognizedRevenue: 0 recognizedRevenue: 0 unrecognizedRevenue: 100 currency: USD notes: some notes createdOn: '2017-03-03 09:55:53' updatedOn: '2017-03-03 09:55:53' accountId: 2c90838f42cf16030142cf215ecb0014 productChargeId: 4028903b5a7eb9bc015a91a77404016a linkedTransactionId: 4028903b5a7eb9bc015a91df45ea024e linkedTransactionNumber: DM00000003 linkedTransactionType: DebitMemoItem referenceId: null revenueScheduleDate: '2017-03-03' revenueItems: - accountingPeriodName: Mar-2017 isAccountingPeriodClosed: false amount: 50 currency: USD accountingPeriodStartDate: '2017-03-01' accountingPeriodEndDate: '2017-03-31' recognizedRevenueAccountingCodeType: null recognizedRevenueAccountingCode: null deferredRevenueAccountingCodeType: null deferredRevenueAccountingCode: null - accountingPeriodName: Apr-2017 isAccountingPeriodClosed: false amount: 50 currency: USD accountingPeriodStartDate: '2017-04-01' accountingPeriodEndDate: '2017-04-30' recognizedRevenueAccountingCodeType: null recognizedRevenueAccountingCode: null deferredRevenueAccountingCodeType: null deferredRevenueAccountingCode: null - number: RS-00000120 recognitionRuleName: Custom - Unlimited recognition amount: 98.9 undistributedUnrecognizedRevenue: 0 recognizedRevenue: 0 unrecognizedRevenue: 100 currency: USD notes: notes createdOn: '2017-03-03 09:36:57' updatedOn: '2017-03-03 09:36:57' accountId: 2c90838f42cf16030142cf215ecb0014 productChargeId: 4028903b5a7eb9bc015a91a77404016a linkedTransactionId: 4028903b5a7eb9bc015a91cc368101d1 linkedTransactionNumber: DM00000002 linkedTransactionType: DebitMemoItem referenceId: null revenueScheduleDate: '2017-03-03' revenueItems: - accountingPeriodName: Jan-2016 isAccountingPeriodClosed: false amount: 98.9 currency: USD accountingPeriodStartDate: '2016-01-01' accountingPeriodEndDate: '2016-01-31' recognizedRevenueAccountingCodeType: null recognizedRevenueAccountingCode: null deferredRevenueAccountingCodeType: null deferredRevenueAccountingCode: null success: true schema: $ref: '#/definitions/GETRSDetailsByProductChargeType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize_finance_revenue' - type: string in: path name: account-key description: 'The account number or account ID. ' required: true - type: string in: path name: charge-key description: 'The unique ID of a product rate plan charge. For example, 8a8082e65ba86084015bb323d3c61d82. ' required: true /v1/revenue-schedules/{rs-number}: get: summary: List all details of a revenue schedule operationId: GET_RS description: 'Retrieves the details of a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: rs-number in: path required: true type: string description: 'Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". ' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: number: RS-00000008 recognitionRuleName: Recognize upon invoicing amount: 50 undistributedUnrecognizedRevenue: -10 recognizedRevenue: 0 unrecognizedRevenue: 50 currency: USD notes: change recognition term createdOn: '2014-01-20 16:36:45' updatedOn: '2014-01-28 17:05:52' accountId: 2c92c0f8439770960143b2141f5a584e subscriptionId: 2c92c0f943977b4f0143b23487994327 subscriptionChargeId: 2c92c0f943977b4f0143b23487ed432e linkedTransactionId: 2c92c095439782cd0143b239aa234cf5 linkedTransactionType: InvoiceItem referenceId: null revenueScheduleDate: '2014-01-20' revenueItems: - accountingPeriodName: Nov'2013 isAccountingPeriodClosed: true amount: 60 currency: USD accountingPeriodStartDate: '2013-10-01' accountingPeriodEndDate: '2013-10-31' recognizedRevenueAccountingCodeType: 'Revenue: Sales' recognizedRevenueAccountingCode: MONTHLY RECURRING CHARGE deferredRevenueAccountingCodeType: 'Liabilities: Deferred Revenue' deferredRevenueAccountingCode: MONTHLY RECURRING CHARGE - accountingPeriodName: Open-Ended isAccountingPeriodClosed: false amount: -10 currency: USD accountingPeriodStartDate: '2013-11-01' accountingPeriodEndDate: null recognizedRevenueAccountingCodeType: 'Revenue: Sales' recognizedRevenueAccountingCode: MONTHLY RECURRING CHARGE deferredRevenueAccountingCodeType: 'Liabilities: Sales' deferredRevenueAccountingCode: MONTHLY RECURRING CHARGE success: true description: '' schema: $ref: '#/definitions/GETRSDetailType' delete: summary: Delete a revenue schedule operationId: DELETE_RS description: | Deletes a revenue schedule by specifying its revenue schedule number ### Prerequisites You must have the Delete Custom Revenue Schedule permissions in Zuora Finance. The revenue schedule must not be associated with any invoice item, invoice item adjustment, or credit/debit memo item in Zuora Billing. tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: rs-number in: path required: true type: string description: |2 Revenue schedule number of the revenue schedule you want to delete, for example, RS-00000256. To be deleted, the revenue schedule: * Must be using a custom unlimited recognition rule. * Cannot have any revenue in a closed accounting period. * Cannot be included in a summary journal entry. * Cannot have a revenue schedule date in a closed accounting period. responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/revenue-schedules/{rs-number}/basic-information: put: summary: Update a revenue schedule operationId: PUT_RSBasicInfo description: 'Retrieves basic information of a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: rs-number in: path required: true type: string description: 'Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". ' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTRSBasicInfoType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods: put: summary: Distribute revenue across accounting periods operationId: PUT_RevenueAcrossAP description: 'Distributes revenue by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: rs-number in: path required: true type: string description: 'Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". ' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTAllocateManuallyType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueEventNumber: RE-00000326 success: true description: '' schema: $ref: '#/definitions/PUTRevenueScheduleResponseType' /v1/revenue-schedules/{rs-number}/distribute-revenue-on-specific-date: put: summary: Distribute revenue on a specific date operationId: PUT_RevenueSpecificDate description: 'Distributes revenue on a specific recognition date. Request and response field descriptions and sample code are provided. ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: rs-number in: path required: true type: string description: 'Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". ' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTSpecificDateAllocationType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueEventNumber: RE-00000326 success: true description: '' schema: $ref: '#/definitions/PUTRevenueScheduleResponseType' /v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range: put: summary: Distribute revenue in a recognition period operationId: PUT_RevenueByRecognitionStartandEndDates description: 'Distributes revenue by specifying the recognition start and end dates. Request and response field descriptions and sample code are provided. ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: rs-number in: path required: true type: string description: "Revenue schedule number. Specify the revenue schedule whose\ \ revenue you want to distribute.\n \nThe revenue schedule number is always\ \ prefixed with \"RS\", for example, \"RS-00000001\".\n" - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTRSTermType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueEventNumber: RE-00000326 success: true description: '' schema: $ref: '#/definitions/PUTRevenueScheduleResponseType' /v1/revenue-schedules/subscription-charges/{charge-key}: post: summary: Create a revenue schedule by subscription charge key operationId: POST_RSforSubscCharge description: | Creates a revenue schedule by specifying the subscription charge. This method is for custom unlimited revenue recognition only. **Note**: You can create a maximum of 3,000 revenue schedules for a subscription charge. tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - name: charge-key in: path description: ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012. required: true type: string - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTRevenueScheduleByChargeType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueScheduleNumber: rs-00000001 success: true description: '' schema: $ref: '#/definitions/POSTRevenueScheduleByChargeResponseType' get: summary: List revenue schedules by subscription charge key operationId: GET_RSforSubscCharge description: 'Retrieves the revenue schedule details by specifying subscription charge ID. Request and response field descriptions and sample code are provided ' tags: - Revenue Schedules parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize_finance_revenue' - name: charge-key in: path description: ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: revenueSchedules: - number: RS-00000291 recognitionRuleName: Recognize upon invoicing amount: 50 undistributedUnrecognizedRevenue: 50 recognizedRevenue: 0 unrecognizedRevenue: 50 currency: USD notes: null createdOn: '2014-01-21 13:59:25' updatedOn: '2014-01-21 13:59:25' accountId: 2c92c0f8439770960143b2141f5a584e subscriptionId: 2c92c0f943977b4f0143b23487994327 subscriptionChargeId: 2c92c0f943977b4f0143b23487ed432e linkedTransactionId: 2c92c094439782460143b62c2ee90f5a linkedTransactionType: InvoiceItem referenceId: null revenueScheduleDate: '2014-01-21' revenueItems: - accountingPeriodName: Open-Ended isAccountingPeriodClosed: false amount: 50 currency: USD accountingPeriodStartDate: '2013-12-11' accountingPeriodEndDate: null recognizedRevenueAccountingCodeType: null recognizedRevenueAccountingCode: null deferredRevenueAccountingCodeType: null deferredRevenueAccountingCode: null - number: RS-00000290 recognitionRuleName: Recognize upon invoicing amount: 50 undistributedUnrecognizedRevenue: 50 recognizedRevenue: 0 unrecognizedRevenue: 50 currency: USD notes: null createdOn: '2014-01-21 13:59:25' updatedOn: '2014-01-21 13:59:25' accountId: 2c92c0f8439770960143b2141f5a584e subscriptionId: 2c92c0f943977b4f0143b23487994327 subscriptionChargeId: 2c92c0f943977b4f0143b23487ed432e linkedTransactionId: 2c92c094439782460143b62c2ee60f59 linkedTransactionNumber: INV00000838 linkedTransactionType: InvoiceItem referenceId: null revenueScheduleDate: '2014-01-21' revenueItems: - accountingPeriodName: Open-Ended isAccountingPeriodClosed: false amount: 50 currency: USD accountingPeriodStartDate: '2013-12-11' accountingPeriodEndDate: null recognizedRevenueAccountingCodeType: null recognizedRevenueAccountingCode: null deferredRevenueAccountingCodeType: null deferredRevenueAccountingCode: null nextPage: https://rest.zuora.com/v1/revenue-schedules/subscription-charges/2c92c0f943977b4f0143b23487ed432e?page=2&pageSize=8 success: true description: '' schema: $ref: '#/definitions/GETRSDetailsByChargeType' /v1/transactions/invoices/accounts/{account-key}: get: summary: List all invoices for an account operationId: GET_TransactionInvoice description: "Retrieves invoices for a specified account. \nInvoices are returned\ \ in reverse chronological order by **updatedDate**.\n" tags: - Transactions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' - name: account-key in: path description: 'Account number or account ID. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: invoices: - id: 8a88818e66bdd34d0166be4589b60031 accountId: 2c9891b06661f78c01667bc6dc090202 accountNumber: AN_1539674921782 accountName: AC_AC_15396749217821539674921782 invoiceDate: '2018-10-29' invoiceNumber: INV00000001 dueDate: '2018-10-29' invoiceTargetDate: '2018-10-29' amount: 9.68 balance: 9.68 creditBalanceAdjustmentAmount: 0 createdBy: 2c9891b06661f78c01667bc6c7600068 status: Draft reversed: false body: null invoiceItems: https://rest.zuora.com/v1/invoices/8a88818e66bdd34d0166be4589b60031/items invoiceFiles: https://rest.zuora.com/v1/invoices/8a88818e66bdd34d0166be4589b60031/files success: true description: '' schema: $ref: '#/definitions/GETInvoiceFileWrapper' /v1/transactions/payments/accounts/{account-key}: get: summary: List all payments for an account operationId: GET_TransactionPayment description: | Retrieves payments for a specified account. Payments are returned in reverse chronological order by **updatedDate**. tags: - Transactions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' - name: account-key in: path description: Account number or account ID. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true payments: - paymentMethodId: 2c92c8f83dabf9cf013daef12dd303b0 paidInvoices: - invoiceId: 2c92a09539190dbe0139190f42780012 invoiceNumber: INV00000159 appliedPaymentAmount: 5.0 - invoiceId: 2c92a0953a3fa95d013a407c10a60100 invoiceNumber: INV00000323 appliedPaymentAmount: 139722.1 - invoiceId: 2c92a09739190dc60139194bcf1b0098 invoiceNumber: INV00000160 appliedPaymentAmount: 10521.0 effectiveDate: '2013-03-27' accountId: 2c92a0f9391832b10139183e277a0042 accountName: subscribeCallYan_1 id: 2c92c8f83dabf9cf013daf3bfa0305a6 status: Processed paymentNumber: P-00000075 gatewayTransactionNumber: null type: Electronic accountNumber: A00001115 amount: 150248.1 - paymentMethodId: 2c92a0f9391832b10139183e279e0044 paidInvoices: - invoiceId: 2c92a09539190dbe0139190f42780012 invoiceNumber: INV00000159 appliedPaymentAmount: 5.0 effectiveDate: '2012-08-11' accountId: 2c92a0f9391832b10139183e277a0042 accountName: subscribeCallYan_1 id: 2c92a0f9391832b101391922ad5f049d status: Processed paymentNumber: P-00000056 gatewayTransactionNumber: null type: Electronic accountNumber: A00001115 amount: 5.0 description: '' schema: $ref: '#/definitions/GETPaymentsType' /v1/object/account: post: summary: 'CRUD: Create an account' operationId: Object_POSTAccount description: 'Creates an account without creating any associated objects such as subscriptions. ' tags: - Accounts parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: CreateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyCreateAccount' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e0321fdf4fab description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/account/{id}: get: summary: 'CRUD: Retrieve an account' operationId: Object_GETAccount description: 'Retrieves the information about one specific account. ' tags: - Accounts parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: AccountNumber: AN_1476935136687 AllowInvoiceEdit: false Id: 2c93808457d787030157e031b5b74a9d AutoPay: true InvoiceDeliveryPrefsPrint: false UpdatedDate: '2016-10-20T05:45:37.000+02:00' CreditBalance: 0 BillCycleDay: 1 BcdSettingOption: ManualSet PaymentTerm: Due Upon Receipt Status: Draft TotalInvoiceBalance: 0 UpdatedById: 2c93808457d787030157e0319d644922 Batch: Batch1 CreatedById: 2c93808457d787030157e0319d644922 InvoiceDeliveryPrefsEmail: false Name: AC_1476935136687 SoldToId: 2c93808457d787030157e031b6444a9e Notes: this is notes Balance: 0 InvoiceTemplateId: 2c93808457d787030157e031a33c4a94 CrmId: crmid BillToId: 2c93808457d787030157e031b6444a9e CreatedDate: '2016-10-20T05:45:36.000+02:00' DefaultPaymentMethodId: 2c93808457d787030157e031b6d24a9f Currency: USD PartnerAccount: true LastMetricsUpdate: '2023-01-10T03:42:18.000+02:00' description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetAccount' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' put: summary: 'CRUD: Update an account' operationId: Object_PUTAccount description: 'Updates an account. ' tags: - Accounts parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyAccount' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e0321fdf4fab description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' delete: summary: 'CRUD: Delete an account' operationId: Object_DELETEAccount description: | Deletes a specific account asynchronously. **Note:** When [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) is enabled, before deleting a customer account, you must delete all related orders and subscriptions where this account has been referenced as a subscription owner or invoice owner. tags: - Accounts parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: { "success": true, "id": "2c93808457d787030157e031b1ea4a98" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: { "message": "Authentication error" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/amendment/{id}: get: summary: 'CRUD: Retrieve an amendment' operationId: Object_GETAmendment description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
tags: - Amendments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: RenewalSetting: RENEW_WITH_SPECIFIC_TERM Id: 2c93808457d787030157e02e430c1f15 UpdatedDate: '2016-10-20T05:41:50.000+02:00' SubscriptionId: 2c93808457d787030157e02e3ef61f02 ServiceActivationDate: '2016-10-20' CurrentTermPeriodType: Month Description: AMtssl1bnuq1 ContractEffectiveDate: '2016-10-20' CreatedById: 2c93808457d787030157e02e0bcf1d0c CreatedDate: '2016-10-20T05:41:50.000+02:00' Name: AMtssl1bnuq1_new CustomerAcceptanceDate: '2016-10-20' Code: A-AM00000004 RenewalTermPeriodType: Month Type: NewProduct Status: Draft UpdatedById: 2c93808457d787030157e02e0bcf1d0c EffectiveDate: '2016-10-20' description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetAmendment' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update an amendment' operationId: Object_PUTAmendment description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
tags: - Amendments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyAmendment' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e02e430c1f15 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' delete: summary: 'CRUD: Delete an amendment' operationId: Object_DELETEAmendment description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
Invoiced amendments cannot usually be deleted. One exception to this rule is auto-renew amendments. You can delete the last auto-renew amendment even if an invoice has been generated. tags: - Amendments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: success: true id: 2c93808457d787030157e02e3a541ef4 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/communication-profile/{id}: get: summary: 'CRUD: Retrieve a communication profile' operationId: Object_GETCommunicationProfile description: '' tags: - Communication Profiles parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetCommunicationProfile' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' /v1/object/credit-balance-adjustment: post: summary: 'CRUD: Create a credit balance adjustment' operationId: Object_POSTCreditBalanceAdjustment description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
' tags: - Credit Balance Adjustments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: CreateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyCreateCreditBalanceAdjustment' responses: '200': examples: application/json: Success: true Id: 2c92c0f96a531e4f016a5377af993d87 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Errors: - Code: INVALID_VALUE Message: The invoice could not be found. It may have been deleted by another user. Success: false description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/credit-balance-adjustment/{id}: get: summary: 'CRUD: Retrieve a credit balance adjustment' operationId: Object_GETCreditBalanceAdjustment description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
' tags: - Credit Balance Adjustments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: Id: 2c93808457d787030157e02f640b2c9f CancelledOn: '2016-10-20T05:43:05.000+02:00' Amount: 30.8 UpdatedById: 2c93808457d787030157e02f409a2af9 CreatedById: 2c93808457d787030157e02f409a2af9 CreatedDate: '2016-10-20T05:43:04.000+02:00' ReasonCode: Standard Adjustment SourceTransactionNumber: INV00000001 Number: CBA-00000001 AdjustmentDate: '2016-10-20' Type: Increase Status: Canceled AccountId: 2c93808457d787030157e02f5fb82c76 SourceTransactionId: 2c93808457d787030157e02f60a42c87 SourceTransactionType: Invoice UpdatedDate: '2016-10-20T05:43:05.000+02:00' description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetCreditBalanceAdjustment' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update a credit balance adjustment' operationId: Object_PUTCreditBalanceAdjustment description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
' tags: - Credit Balance Adjustments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyCreditBalanceAdjustment' responses: '200': examples: application/json: Success: true Id: 2c92c0f96a531e4f016a5377af993d87 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/export: post: summary: 'CRUD: Create an export' operationId: Object_POSTExport description: | Use this operation to create a data source export. After you have created a data source export, use [CRUD: Retrieve an export](https://developer.zuora.com/api-references/older-api/operation/Object_GETExport/) to check the status of the data source export and access the exported data. ### Limits Zuora system enforces the following limits on data source exports: * The maximum processing time per export is 3 hours. If an export is executed for longer than 3 hours, it will be killed automatically. * The maximum number of concurrent exports is 50 per tenant. Exports in `Pending` and `Processing` status are counted towards the concurrent export limit. Zuora system will reject the subsequent data source export requests once the concurrent export limit is reached. When you export data from Zuora, each exported file is available for download for 7 days. Data source exports (Export objects) older than 90 days are automatically deleted. **Note:** This operation supports the [Export ZOQL](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL) query language. However, this operation does not support some data sources, objects, and fields in Export ZOQL queries. For full compatibility with Export ZOQL, Zuora recommends that you use the [AQuA API](https://knowledgecenter.zuora.com/DC_Developers/T_Aggregate_Query_API) instead of this operation. tags: - Exports parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: X-Zuora-WSDL-Version in: header required: false type: string description: 'Set the value to `80` if you want to export data about [Debit Taxation Item](https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference/Debit_Taxation_Item_Data_Source) and [Credit Taxation Item](https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference/Credit_Taxation_Item_Data_Source). ' - name: CreateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyCreateExport' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e03222184fae description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/export/{id}: get: summary: 'CRUD: Retrieve an export' operationId: Object_GETExport description: | Use this operation to check the status of a data source export and access the exported data. When you export data from Zuora, each exported file is available for download for 7 days. Data source exports (Export objects) older than 90 days are automatically deleted. tags: - Exports parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: Format: csv Query: select * from account Encrypted: false CreatedById: 2c93808457d787030157e03202294e25 CreatedDate: '2016-10-20T05:46:04.000+02:00' Name: test_Export_1476935164445 Zip: true Size: 5 UpdatedDate: '2016-10-20T05:46:04.000+02:00' UpdatedById: 2c93808457d787030157e03202294e25 Status: Completed Id: 2c93808457d787030157e03222184fae FileId: 2c93808457d787030157e032228d4fb0 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetExport' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' /v1/object/feature: post: summary: 'CRUD: Create a feature' operationId: Object_POSTFeature description: '' tags: - Features parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: CreateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyCreateFeature' responses: '200': examples: application/json: Success: true Id: 2c92c0f971baf4e80171bc0a3fbc75a1 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Success: false Errors: - Code: INVALID_VALUE Message: data integrity violation description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/feature/{id}: get: summary: 'CRUD: Retrieve a feature' operationId: Object_GETFeature description: '' tags: - Features parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: Id: 2c93808457d787030157e02f82872e25 Status: Active CreatedDate: '2016-10-20T05:43:12.000+02:00' UpdatedDate: '2016-10-20T05:43:12.000+02:00' FeatureCode: feature_code_1476934992537 CreatedById: 2c93808457d787030157e02f68272cae UpdatedById: 2c93808457d787030157e02f68272cae Name: name_1476934992537_new Description: this is desc description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetFeature' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update a feature' operationId: Object_PUTFeature description: '' tags: - Features parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyFeature' responses: '200': examples: application/json: Success: true Id: 2c92c0f971baf4e80171bc0a3fbc75a1 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Success: false Errors: - Code: INVALID_VALUE Message: 'invalid value for field Status: Deactivated' description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' delete: summary: 'CRUD: Delete a feature' operationId: Object_DELETEFeature description: '' tags: - Features parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: success: true id: 2c93808457d787030157e02f80e92e24 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/invoice/{id}: put: summary: 'CRUD: Update an invoice' operationId: Object_PUTInvoice description: '' tags: - Invoices parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyInvoice' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e031d86c4c57 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' get: summary: 'CRUD: Retrieve an invoice' operationId: Object_GETInvoice description: "" tags: - Invoices parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: fields in: query required: false type: string description: "Object fields to return" - name: id in: path description: "Object id" required: true type: string responses: '200': examples: application/json: { "InvoiceDate": "2011-01-10", "TaxExemptAmount": 0, "UpdatedDate": "2016-10-20T05:45:45.000+02:00", "CreditBalanceAdjustmentAmount": 0, "Status": "Posted", "TargetDate": "2016-10-20", "BillToContactId": "2c93808457d787030157e031bb3f43f8", "PaymentTerm": "Net 30", "AccountId": "2c93808457d787030157e031d2704c28", "IncludesOneTime": true, "InvoiceNumber": "INV00000002", "UpdatedById": "2c93808457d787030157e031bb3f4aa5", "PaymentAmount": 0, "Id": "2c93808457d787030157e031d86c4c57", "TaxAmount": 0, "IncludesUsage": true, "CreatedById": "2c93808457d787030157e031bb3f4aa5", "CreatedDate": "2016-10-20T05:45:45.000+02:00", "Body": "JVBERi0xLjUNCjQg......QNCiUlRU9GDQo=", "PostedDate": "2016-10-20T05:45:45.000+02:00", "Amount": 23.92, "Balance": 23.92, "RefundAmount": 0, "AmountWithoutTax": 23.92, "AdjustmentAmount": 0, "PostedBy": "2c93808457d787030157e031bb3f4aa5", "DueDate": "2011-01-10", "IncludesRecurring": true, "SourceType":"Subscription", "SequenceSetId": "2c93808457d787030157e031bb3f4ab1", "CreditMemoAmount": 0 } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyGetInvoice' '401': examples: application/json: { "message": "Authentication error" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: { "records":{}, "size":0, "done":true } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyNoDataResponse' # DELETE Invoice delete: summary: 'CRUD: Delete an invoice' operationId: Object_DELETEInvoice description: "" tags: - Invoices parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: { "success": true, "id": "2c93808457d787030157e02f149f2922" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: { "message": "Authentication error" } description: "" headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Remaining: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. RateLimit-Reset: type: number description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. Zuora-Track-Id: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/invoice-adjustment: post: summary: 'CRUD: Create an invoice adjustment' operationId: Object_POSTInvoiceAdjustment description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
' tags: - Invoice Adjustments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: CreateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyCreateInvoiceAdjustment' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e030d3043f79 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/invoice-adjustment/{id}: get: summary: 'CRUD: Retrieve an invoice adjustment' operationId: Object_GETInvoiceAdjustment description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
' tags: - Invoice Adjustments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: AdjustmentNumber: IA-00000001 CustomerName: AC_1476935078064 Id: 2c93808457d787030157e030d3043f79 AccountingCode: Accounts Receivable ReasonCode: Standard Adjustment AccountId: 2c93808457d787030157e030d0a43f53 CustomerNumber: AN_1476935078064 InvoiceId: 2c93808457d787030157e030d10f3f64 ImpactAmount: -1.2 CreatedById: 2c93808457d787030157e030b4fa3dd6 CreatedDate: '2016-10-20T05:44:38.000+02:00' Type: Credit Amount: 1.2 AdjustmentDate: '2016-10-20' Comments: this is comments UpdatedDate: '2016-10-20T05:44:38.000+02:00' Status: Processed InvoiceNumber: INV00000001 ReferenceId: refid-1476935078657 UpdatedById: 2c93808457d787030157e030b4fa3dd6 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetInvoiceAdjustment' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update an invoice adjustment' operationId: Object_PUTInvoiceAdjustment description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
' tags: - Invoice Adjustments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyInvoiceAdjustment' responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' delete: summary: 'CRUD: Delete an invoice adjustment' operationId: Object_DELETEInvoiceAdjustment description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
' tags: - Invoice Adjustments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/invoice-item/{id}: get: summary: 'CRUD: Retrieve an invoice item' operationId: Object_GETInvoiceItem description: '' tags: - Invoice Items parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: ServiceEndDate: '2016-10-20' Id: 2c93808457d787030157e03089c03c3b ChargeDate: '2016-10-20T05:44:19.000+02:00' AccountingCode: Accounts Receivable UnitPrice: 10 SubscriptionId: 2c93808457d787030157e03088bf3c24 ProcessingType: 0 Quantity: 1 ChargeAmount: 10 ServiceStartDate: '2016-10-20' CreatedById: 2c93808457d787030157e03071873a9a CreatedDate: '2016-10-20T05:44:19.000+02:00' TaxAmount: 0 ChargeName: OneTime_Flat Fee Pricing1476935059154 SKU: API-SKU1476935058740 SourceItemType: SubscriptionComponent UpdatedDate: '2016-10-20T05:44:21.000+02:00' UpdatedById: 2c93808457d787030157e03071873a9a TaxExemptAmount: 0 excludeItemBillingFromRevenueAccounting: true InvoiceId: 2c93808457d787030157e03089bb3c39 ProductDescription: Create product via API RatePlanChargeId: 2c93808457d787030157e03088ec3c2d description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetInvoiceItem' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' /v1/object/invoice-item-adjustment: post: summary: 'CRUD: Create an invoice item adjustment' operationId: Object_POSTInvoiceItemAdjustment description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
' tags: - Invoice Item Adjustments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: CreateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyCreateInvoiceItemAdjustment' responses: '200': examples: application/json: Success: true Id: 8a90da067e5bae89017e5c9aa3f70d1d description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/invoice-item-adjustment/{id}: get: summary: 'CRUD: Retrieve an invoice item adjustment' operationId: Object_GETInvoiceItemAdjustment description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
' tags: - Invoice Item Adjustments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: AdjustmentNumber: IIA-00000001 ServiceEndDate: '2016-10-20' Id: 2c93808457d787030157e0324aea5158 AccountingCode: Accounts Receivable UpdatedDate: '2016-10-20T05:46:14.000+02:00' AccountId: 2c93808457d787030157e032485b5131 Comment: this is comments InvoiceNumber: INV00000001 InvoiceId: 2c93808457d787030157e03248c75142 ServiceStartDate: '2016-10-20' InvoiceItemName: OneTime_Flat Fee Pricing1476935174089 CreatedDate: '2016-10-20T05:46:14.000+02:00' ReasonCode: Standard Adjustment UpdatedById: 2c93808457d787030157e032283c4fb2 Amount: 1.2 AdjustmentDate: '2016-10-20' Type: Credit Status: Processed SourceType: InvoiceDetail SourceId: 2c93808457d787030157e03248c95144 ReferenceId: refid-1476935174845 CreatedById: 2c93808457d787030157e032283c4fb2 ExcludeItemBillingFromRevenueAccounting: 'true' description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetInvoiceItemAdjustment' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update an invoice item adjustment' operationId: Object_PUTInvoiceItemAdjustment description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
' tags: - Invoice Item Adjustments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyInvoiceItemAdjustment' responses: '200': examples: application/json: Success: true Id: 8a90da067e5bae89017e5c9aa3f70d1d description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' delete: summary: 'CRUD: Delete an invoice item adjustment' operationId: Object_DELETEInvoiceItemAdjustment description: 'Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
' tags: - Invoice Item Adjustments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: Success: true Id: 8a90da067e5bae89017e5c9aa3f70d1d description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/invoice-payment: post: summary: 'CRUD: Create an invoice payment' operationId: Object_POSTInvoicePayment description: '' tags: - Invoice Payments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: CreateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyCreateInvoicePayment' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e02dee6e1b7a description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/invoice-payment/{id}: get: summary: 'CRUD: Retrieve an invoice payment' operationId: Object_GETInvoicePayment description: '' tags: - Invoice Payments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: Id: 2c93808457d787030157e02dee6e1b7a PaymentId: 2c93808457d787030157e02de5fc1b57 CreatedDate: '2016-10-20T05:41:29.000+02:00' UpdatedDate: '2016-10-20T05:41:29.000+02:00' Amount: 10 CreatedById: 2c93808457d787030157e02dc3d919dc UpdatedById: 2c93808457d787030157e02dc3d919dc RefundAmount: 0 InvoiceId: 2c93808457d787030157e02deadb1b6d description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetInvoicePayment' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update an invoice payment' operationId: Object_PUTInvoicePayment description: '' tags: - Invoice Payments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyInvoicePayment' responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/invoice-split/{id}: get: summary: 'CRUD: Retrieve an invoice split' operationId: Object_GETInvoiceSplit description: '' tags: - Invoice Splits parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: UpdatedById: 2c93808457d787030157e03111d542ae Id: 2c93808457d787030157e0312cb2445c CreatedById: 2c93808457d787030157e03111d542ae CreatedDate: '2016-10-20T05:45:01.000+02:00' UpdatedDate: '2016-10-20T05:45:01.000+02:00' InvoiceId: 2c93808457d787030157e0312aa34449 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetInvoiceSplit' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' /v1/object/invoice-split-item/{id}: get: summary: 'CRUD: Retrieve an invoice split item' operationId: Object_GETInvoiceSplitItem description: '' tags: - Invoice Split Items parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: InvoiceDate: '2011-01-20' UpdatedById: 2c93808457d787030157e031bb3f4aa5 CreatedById: 2c93808457d787030157e031bb3f4aa5 CreatedDate: '2016-10-20T05:45:45.000+02:00' UpdatedDate: '2016-10-20T05:45:45.000+02:00' SplitPercentage: 50.9 PaymentTerm: Due Upon Receipt Id: 2c93808457d787030157e031d7214c55 InvoiceSplitId: 2c93808457d787030157e031d5844c53 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetInvoiceSplitItem' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' /v1/object/payment: post: summary: 'CRUD: Create a payment' operationId: Object_POSTPayment description: 'Creates a payment for one or multiple invoices. ' tags: - Payments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: CreateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyCreatePayment' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e03197714910 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/payment/{id}: get: summary: 'CRUD: Retrieve a payment' operationId: Object_GETPayment description: "Retrieves the information about one specific payment. \n" tags: - Payments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: 'The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352. ' required: true type: string responses: '200': examples: application/json: PaymentNumber: P-00000036 GatewayResponse: This transaction has been approved by Test gateway. Id: 2c92c095592623ea01596621ada84352 UpdatedDate: '2017-01-03T13:00:00.000-08:00' GatewayState: Submitted Source: PaymentRun AccountId: 2c92c0f94fd7f22d014fef0b703e26f4 BankIdentificationNumber: '111111' ReferenceId: '3115031.8425435387' PaymentMethodSnapshotId: 2c92c095592623ea01596621ada44351 UpdatedById: 2c92c0f955e2bcfc0155e3019d0c4963 SubmittedOn: '2017-01-03T13:00:00.000-08:00' Type: Electronic CreatedDate: '2017-01-03T13:00:00.000-08:00' RefundAmount: 0 SourceName: PR-00001035 Amount: 19696.44 PaymentMethodId: 2c92c0f94fd7f22d014fef0b714e26f9 CreatedById: 2c92c0f955e2bcfc0155e3019d0c4963 Status: Processed AppliedCreditBalanceAmount: 0 Gateway: Test Gateway2 GatewayResponseCode: approve EffectiveDate: '2017-01-03' description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetPayment' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update a payment' operationId: Object_PUTPayment description: "Updates a payment. \n" tags: - Payments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: 'The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352. ' required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyPayment' responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: Id: 2c92c0f85d5964dc015d59bb40ff3f0e Success: true schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' delete: summary: 'CRUD: Delete a payment' operationId: Object_DELETEPayment description: "Deletes a payment. Only payments with the Cancelled status can\ \ be deleted. \n" tags: - Payments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: 'The unique ID of the payment to be deleted. For example, 2c92c0f85d4e95ae015d4f7e5d690622. ' required: true type: string responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: Id: 2c92c0f85d4e95ae015d4f7e5d690622 Success: true schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/payment-method: post: summary: 'CRUD: Create a payment method' operationId: Object_POSTPaymentMethod description: | Use this operation to create either a payment method associated with a specific customer account, or an orphan payment method that is not associated with any customer account. The orphan payment method must be associated with a customer account within 10 days. Otherwise, it will be deleted. tags: - Payment Methods parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: CreateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyCreatePaymentMethod' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e03220ec4fad description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/payment-method/{id}: get: summary: 'CRUD: Retrieve a payment method' operationId: Object_GETPaymentMethod description: '' tags: - Payment Methods parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: CreditCardExpirationMonth: 12 CreditCardAddress1: 312 2nd Ave W Id: 2c93808457d787030157e0314e8145d7 CreditCardExpirationYear: 2020 UpdatedDate: '2016-10-20T05:45:10.000+02:00' CreditCardCity: Seattle CreditCardState: Washington AccountId: 2c93808457d787030157e0314c0945d4 Type: CreditCard UpdatedById: 2c93808457d787030157e0312ef1445e CreditCardCountry: United States AchAddress1: 312 2nd Ave W CreditCardType: Visa CreatedById: 2c93808457d787030157e0312ef1445e CreditCardPostalCode: '98119' CreditCardHolderName: Somebody CreatedDate: '2016-10-20T05:45:10.000+02:00' TotalNumberOfProcessedPayments: 1 PaymentMethodStatus: Active NumConsecutiveFailures: 7 TotalNumberOfErrorPayments: 0 CreditCardMaskNumber: '************1111' LastTransactionStatus: Approved LastTransactionDateTime: '2016-10-20T05:45:10.000+02:00' UseDefaultRetryRule: true BankIdentificationNumber: '411111' IdentityNumber: '' IsCompany: false CompanyName: '' Active: false description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetPaymentMethod' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update a payment method' operationId: Object_PUTPaymentMethod description: "Updates a payment method." tags: - Payment Methods parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyPaymentMethod' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e02fced332a2 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' delete: summary: 'CRUD: Delete a payment method' operationId: Object_DELETEPaymentMethod description: '' tags: - Payment Methods parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: success: true id: 2c93808457d787030157e02fcc8e329f description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/product-feature/{id}: get: summary: 'CRUD: Retrieve a product feature' operationId: Object_GETProductFeature description: '' tags: - Product Features parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: null description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetProductFeature' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' delete: summary: 'CRUD: Delete a product feature' operationId: Object_DELETEProductFeature description: '' tags: - Product Features parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: success: true id: 2c93808457d787030157e02d820f16d3 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/rate-plan/{id}: get: summary: 'CRUD: Retrieve a rate plan' operationId: Object_GETRatePlan description: '' tags: - Rate Plans parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: UpdatedById: 2c93808457d787030157e02ea77723ef UpdatedDate: '2016-10-20T05:42:24.000+02:00' Id: 2c93808457d787030157e02ec54f259e OriginalRatePlanId: 2c93808457d787030157e02ec3c53359 CreatedById: 2c93808457d787030157e02ea77723ef CreatedDate: '2016-10-20T05:42:24.000+02:00' Name: ProductRatePlan1476934943281 AmendmentId: 2c93808457d787030157e02ec4b42599 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetRatePlan' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' /v1/object/rate-plan-charge/{id}: get: summary: 'CRUD: Retrieve a rate plan charge' operationId: Object_GETRatePlanCharge description: '' tags: - Rate Plan Charges parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: PriceChangeOption: NoChange OverageCalculationOption: EndOfSmoothingPeriod Id: 2c93808457d787030157e02f9b802fad ChargeNumber: C-00000001 BillingPeriodAlignment: AlignToCharge UpdatedDate: '2016-10-20T05:43:19.000+02:00' Version: 1 BillCycleDay: 1 BillingPeriod: Month IsLastSegment: true UpToPeriodsType: Billing Periods UpdatedById: 2c93808457d787030157e02f84852e27 Quantity: 1 EndDateCondition: SubscriptionEnd Segment: 1 RatePlanId: 2c93808457d787030157e02f9b762fac ChargeModel: Flat Fee Pricing TriggerEvent: ContractEffective BillingTiming: In Arrears CreatedById: 2c93808457d787030157e02f84852e27 CreatedDate: '2016-10-20T05:43:18.000+02:00' Name: Recurring_Flat Fee Pricing1476934998566 ChargeType: Recurring OverageUnusedUnitsCreditOption: NoCredit RolloverBalance: 0 OriginalId: 2c93808457d787030157e02f9b802fad ListPriceBase: Per Billing Period PriceIncreasePercentage: 0 NumberOfPeriods: 1 BillCycleType: DefaultFromCustomer Description: Recurring Flat Fee Pricing AccountingCode: name_1476934998566 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetRatePlanCharge' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update a rate plan charge' operationId: Object_PUTRatePlanCharge description: '' tags: - Rate Plan Charges parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyRatePlanCharge' responses: '200': examples: application/json: Success: true Id: 2c92c0f86a79e2e4016a8bad616b257c description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/rate-plan-charge-tier/{id}: get: summary: 'CRUD: Retrieve a rate plan charge tier' operationId: Object_GETRatePlanChargeTier description: '' tags: - Rate Plan Charge Tiers parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: UpdatedById: 2c93808457d787030157e02da3161854 CreatedById: 2c93808457d787030157e02da3161854 Price: 30 UpdatedDate: '2016-10-20T05:41:16.000+02:00' StartingUnit: 0 EndingUnit: 0 Id: 2c93808457d787030157e02dbecc19d8 CreatedDate: '2016-10-20T05:41:16.000+02:00' PriceFormat: Flat Fee Tier: 1 RatePlanChargeId: 2c93808457d787030157e02dbee919da description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetRatePlanChargeTier' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' /v1/object/refund: post: summary: 'CRUD: Create a refund' operationId: Object_POSTRefund description: "Creates a refund. \n\nIf you have the Invoice Settlement feature\ \ enabled, you can use this operation to unapply the payment from an invoice\ \ or multiple invoices, and refund the payment. \n\nIf the unapplied payment\ \ is left in the following scenarios, you have to reapply the unapplied payment\ \ to the original invoices:\n\n- An electronic refund in Processing status\ \ is handled to change to Error. An unapplied payment is left. \n- An electronic\ \ refund gets to Error, and payment reapplying fails due to the concurrent\ \ issue. \n- The refund canceling operation updates the status of a refund\ \ from Processed to Canceled. When it is successful, an unapplied payment\ \ is left.\n" tags: - Refunds parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: CreateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyCreateRefund' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e03198c84918 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/refund/{id}: get: summary: 'CRUD: Retrieve a refund' operationId: Object_GETRefund description: '' tags: - Refunds parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: null description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetRefund' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update a refund' operationId: Object_PUTRefund description: '' tags: - Refunds parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyRefund' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e03198c84918 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' delete: summary: 'CRUD: Delete a refund' operationId: Object_DELETERefund description: '' tags: - Refunds parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: success: true id: 2c93808457d787030157e03198c84918 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/refund-invoice-payment/{id}: get: summary: 'CRUD: Retrieve a refund invoice payment' operationId: Object_GETRefundInvoicePayment description: '' tags: - Refund Invoice Payments parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetRefundInvoicePayment' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' /v1/object/refund-transaction-log/{id}: get: summary: 'CRUD: Retrieve a refund transaction log' operationId: Object_GETRefundTransactionLog description: '' tags: - Refund Transaction Logs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: GatewayReasonCodeDescription: This transaction has been approved by Test gateway. Id: 2c93808457d787030157e0304c0538f2 TransactionId: '9036150.175338026' GatewayState: Submitted GatewayReasonCode: approve TransactionDate: '2016-10-20T05:44:04.000+02:00' Gateway: TEST gateway name1476935035677 RefundId: 2c93808457d787030157e0304bf638f0 GatewayTransactionType: Refund description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetRefundTransactionLog' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' /v1/object/subscription/{id}: get: summary: 'CRUD: Retrieve a subscription' operationId: Object_GETSubscription description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
tags: - Subscriptions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: TermStartDate: '2018-05-10' Id: 2c92c0fa6343984c0163498b71fe04be UpdatedDate: '2018-05-11T11:38:03.000+08:00' Version: 1 Revision: '1.0' AutoRenew: false SubscriptionStartDate: '2018-05-10' InitialTerm: 12 InitialTermPeriodType: Month AccountId: 2c92c0fa6343984c0163498b71a604b2 IsInvoiceSeparate: false IsLatestVersion: false CurrentTermPeriodType: Month CurrentTerm: 12 RenewalTermPeriodType: Month ContractEffectiveDate: '2018-05-10' UpdatedById: 2c92c0f9631b0084016323ec8720683d ContractAcceptanceDate: '2018-05-10' CreatedById: 2c92c0f9631b0084016323ec8720683d CreatedDate: '2018-05-10T18:14:25.000+08:00' Name: A-S00000177 Status: Expired ServiceActivationDate: '2018-05-10' OriginalId: 2c92c0fa6343984c0163498b71fe04be RenewalTerm: 12 TermEndDate: '2019-05-10' TermType: TERMED RenewalSetting: RENEW_WITH_SPECIFIC_TERM OriginalCreatedDate: '2018-05-10T18:14:25.000+08:00' SubscriptionEndDate: '2019-05-10' description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetSubscription' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update a subscription' operationId: Object_PUTSubscription description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
tags: - Subscriptions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifySubscription' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e02ea04123cf description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' delete: summary: 'CRUD: Delete a subscription' operationId: Object_DELETESubscription description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
tags: - Subscriptions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: success: true id: 2c93808457d787030157e02ea04123cf description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/subscription-product-feature/{id}: get: summary: 'CRUD: Retrieve a subscription product feature' operationId: Object_GETSubscriptionProductFeature description: |Note: The Subscribe and Amend features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.
tags: - Subscription Product Features parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: RatePlanId: 2c93808457d787030157e0316ae64769 Id: 2c93808457d787030157e0316ae7476a CreatedById: 2c93808457d787030157e03151e845e3 CreatedDate: '2016-10-20T05:45:17.000+02:00' Name: name_1476935116658 FeatureCode: feature_code_1476935116658 FeatureId: 2c93808457d787030157e03167fe4758 UpdatedDate: '2016-10-20T05:45:18.000+02:00' UpdatedById: 2c93808457d787030157e03151e845e3 Description: update description description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetSubscriptionProductFeature' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' /v1/object/taxation-item/{id}: get: summary: 'CRUD: Retrieve a taxation item' operationId: Object_GETTaxationItem description: '' tags: - Taxation Items parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: Jurisdiction: test InvoiceItemId: 2c93808457d787030157e0306cd43a88 Id: 2c93808457d787030157e0306f413a96 AccountingCode: Usage Revenue UpdatedDate: '2016-10-20T05:44:13.000+02:00' TaxCode: taxcode LocationCode: code - 001 CreatedById: 2c93808457d787030157e0304e2f38f8 CreatedDate: '2016-10-20T05:44:13.000+02:00' Name: test TaxCodeDescription: description TaxRateDescription: test TaxAmount: 3 UpdatedById: 2c93808457d787030157e0304e2f38f8 ExemptAmount: 50 TaxRate: 3 TaxRateType: FlatFee TaxDate: '2016-10-20' description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetTaxationItem' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update a taxation item' operationId: Object_PUTTaxationItem description: '' tags: - Taxation Items parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyTaxationItem' responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' delete: summary: 'CRUD: Delete a taxation item' operationId: Object_DELETETaxationItem description: '' tags: - Taxation Items parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/unit-of-measure: post: summary: 'CRUD: Create a unit of measure' operationId: Object_POSTUnitOfMeasure description: '' tags: - Unit Of Measure parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: CreateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyCreateUnitOfMeasure' responses: '200': examples: application/json: Success: true Id: 2c93808457d787030157e030232f3748 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '400': examples: application/json: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyBadRequestResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/object/unit-of-measure/{id}: get: summary: 'CRUD: Retrieve a unit of measure' operationId: Object_GETUnitOfMeasure description: '' tags: - Unit Of Measure parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: fields in: query required: false type: string description: Object fields to return - name: id in: path description: Object id required: true type: string responses: '200': examples: application/json: Active: true Id: 2c93808457d787030157e030232f3748 CreatedById: 2c93808457d787030157e0300f6735d3 CreatedDate: '2016-10-20T05:43:53.000+02:00' UpdatedDate: '2016-10-20T05:43:53.000+02:00' DisplayedAs: name_display_name_1476935033519 UomName: name_1476935033519 RoundingMode: UP UpdatedById: 2c93808457d787030157e0300f6735d3 DecimalPlaces: 9 description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyGetUnitOfMeasure' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' '404': examples: application/json: records: {} size: 0 done: true description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyNoDataResponse' put: summary: 'CRUD: Update a unit of measure' operationId: Object_PUTUnitOfMeasure description: '' tags: - Unit Of Measure parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string - name: ModifyRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyModifyUnitOfMeasure' responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyCreateOrModifyResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' delete: summary: 'CRUD: Delete a unit of measure' operationId: Object_DELETEUnitOfMeasure description: '' tags: - Unit Of Measure parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: Object id required: true type: string responses: '200': description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: $ref: '#/definitions/ProxyDeleteResponse' '401': examples: application/json: message: Authentication error description: '' headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' definitions: AccountCreditCardHolder: description: 'Information about the cardholder of a credit card payment method associated with an account. If you do not provide information about the cardholder, Zuora uses the account''s bill-to contact. ' properties: addressLine1: description: 'First line of the cardholder''s address. ' maxLength: 255 type: string addressLine2: description: 'Second line of the cardholder''s address. ' maxLength: 255 type: string cardHolderName: description: 'Full name of the cardholder as it appears on the card. For example, "John J Smith". ' maxLength: 50 type: string city: description: | City of the cardholder's address. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. maxLength: 40 type: string country: description: | Country of the cardholder's address. The value of this field must be a valid country name or abbreviation. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. maxLength: 64 type: string email: description: 'Email address of the cardholder. ' maxLength: 80 type: string phone: description: 'Phone number of the cardholder. ' maxLength: 40 type: string state: description: 'State or province of the cardholder''s address. ' maxLength: 50 type: string zipCode: description: 'ZIP code or other postal code of the cardholder''s address. ' maxLength: 20 type: string type: object AccountObjectCustomFields: additionalProperties: description: 'Custom fields of the Account object. The name of each custom field has the form*customField*__c. Custom field names are case sensitive.
See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields)
for more information.
'
description: 'Container for custom fields of an Account object.
'
title: accountFieldsCustom
type: object
AccountObjectNSFields:
description: 'Container for Account fields provided by the [Zuora Connector for
NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
properties:
Class__NS:
description: 'Value of the Class field for the corresponding customer account
in NetSuite. Only available if you have installed the [Zuora Connector for
NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
CustomerType__NS:
description: 'Value of the Customer Type field for the corresponding customer
account in NetSuite. The Customer Type field is used when the customer account
is created in NetSuite. Only available if you have installed the [Zuora
Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
enum:
- Company
- Individual
type: string
Department__NS:
description: 'Value of the Department field for the corresponding customer
account in NetSuite. Only available if you have installed the [Zuora Connector
for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
IntegrationId__NS:
description: 'ID of the corresponding object in NetSuite. Only available if
you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
IntegrationStatus__NS:
description: 'Status of the account''s synchronization with NetSuite. Only
available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
Location__NS:
description: 'Value of the Location field for the corresponding customer account
in NetSuite. Only available if you have installed the [Zuora Connector for
NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
Subsidiary__NS:
description: 'Value of the Subsidiary field for the corresponding customer
account in NetSuite. The Subsidiary field is required if you use NetSuite
OneWorld. Only available if you have installed the [Zuora Connector for
NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
SyncDate__NS:
description: 'Date when the account was sychronized with NetSuite. Only available
if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
SynctoNetSuite__NS:
description: 'Specifies whether the account should be synchronized with NetSuite.
Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
enum:
- 'Yes'
- 'No'
type: string
title: accountFieldsNetSuite
type: object
ActionAmendCreditMemo:
description: "Container for credit memos.\n\n**Note:** This container is only\
\ available if you set the WSDL minor version to 107.0 or later in the request\
\ header, and you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\
\ enabled. The Invoice Settlement feature is generally available as of Zuora\
\ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\
\ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\
\ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\
\ for more information. \n"
properties:
TaxAmount:
description: 'Tax amount on the credit memo.
'
format: double
type: number
TotalAmount:
description: 'Credit memo amount.
'
format: double
type: number
TotalAmountWithoutTax:
description: 'Credit memo amount minus tax.
'
format: double
type: number
title: CreditMemo
type: object
ActionAmendCreditMemoData:
properties:
CreditMemo:
$ref: '#/definitions/ActionAmendCreditMemo'
CreditMemoItem:
description: ''
items:
$ref: '#/definitions/ActionAmendCreditMemoItem'
type: array
TaxationItemData:
description: "List of taxation items.\n \n**Note**: This field is only available\
\ if you set the `X-Zuora-WSDL-Version` request header to `120` or later.\n"
items:
properties:
CreditMemoItemId:
description: 'The ID of the credit memo item associated with the taxation
item.
'
type: string
ExemptAmount:
description: 'The calculated tax amount excluded due to the exemption.
'
type: number
Jurisdiction:
description: 'The jurisdiction that applies the tax or VAT. This value
is typically a state, province, county, or city.
'
type: string
LocationCode:
description: 'The identifier for the location based on the value of
the TaxCode field.
'
type: string
Name:
description: 'The name of the taxation item.
'
type: string
TaxAmount:
description: 'The amount of the tax applied to the credit memo.
'
type: number
TaxCode:
description: 'The tax code identifies which tax rules and tax rates
to apply to a specific credit memo.
'
type: string
TaxCodeDescription:
description: 'The description of the tax code.
'
type: string
TaxDate:
description: 'The date when the tax is applied to the credit memo.
'
type: string
TaxRate:
description: 'The tax rate applied to the credit memo.
'
type: number
TaxRateDescription:
description: 'The description of the tax rate.
'
type: string
TaxRateType:
description: 'The type of the tax rate applied to the credit memo.
'
enum:
- Percentage
- FlatFee
type: string
type: object
type: array
title: CreditMemoDatas
type: object
ActionAmendCreditMemoItem:
properties:
AmountWithoutTax:
description: 'The credit memo item amount excluding tax.
'
format: double
type: number
ChargeName:
description: 'Name of this credit memo item.
'
type: string
Description:
description: 'Description of this credit memo item.
'
type: string
ProductRatePlanChargeId:
description: 'ID of the product rate plan charge associated with this credit
memo item.
'
type: string
Quantity:
description: 'Quantity of the charge associated with this credit memo item.
'
type: integer
ServiceEndDate:
description: 'End date of the service period for this credit memo item, as
yyyy-mm-dd.
'
format: date
type: string
ServiceStartDate:
description: 'Service start date of this credit memo item, as yyyy-mm-dd.
'
format: date
type: string
TaxAmount:
description: 'The tax amount of the credit memo item.
'
format: double
type: number
UnitOfMeasure:
description: 'Unit used to measure consumption.
'
type: string
title: CreditMemoItem
type: object
ActionAmendInvoiceData:
properties:
Invoice:
$ref: '#/definitions/Invoice'
InvoiceItem:
description: ''
items:
$ref: '#/definitions/ActionAmendInvoiceItem'
type: array
TaxationItemData:
description: "List of taxation items.\n \n**Note**: This field is only available\
\ if you set the `X-Zuora-WSDL-Version` request header to `120` or later.\n"
items:
properties:
ExemptAmount:
description: 'The calculated tax amount excluded due to the exemption.
'
type: number
InvoiceItemId:
description: 'The ID of the invoice item associated with the taxation
item.
'
type: string
Jurisdiction:
description: 'The jurisdiction that applies the tax or VAT. This value
is typically a state, province, county, or city.
'
type: string
LocationCode:
description: 'The identifier for the location based on the value of
the TaxCode field.
'
type: string
Name:
description: 'The name of the taxation item.
'
type: string
TaxAmount:
description: 'The amount of the tax applied to the invoice.
'
type: number
TaxCode:
description: 'The tax code identifies which tax rules and tax rates
to apply to a specific invoice.
'
type: string
TaxCodeDescription:
description: 'The description of the tax code.
'
type: string
TaxDate:
description: 'The date when the tax is applied to the invoice.
'
type: string
TaxRate:
description: 'The tax rate applied to the invoice.
'
type: number
TaxRateDescription:
description: 'The description of the tax rate.
'
type: string
TaxRateType:
description: 'The type of the tax rate applied to the invoice.
'
enum:
- Percentage
- FlatFee
type: string
type: object
type: array
type: object
ActionAmendInvoiceItem:
properties:
AccountingCode:
description: " The accounting code for the item's charge. Accounting codes\
\ group transactions that contain similar accounting attributes.\n\n\n**Character\
\ limit**: 100\n\n**Values**: inherited from `RatePlanCharge.AccountingCode` "
type: string
AppliedToInvoiceItemId:
description: " Associates a discount invoice item to a specific invoice item.\n\
\n\n**Character limit**: 32\n\n**Values**: inherited from the ID of the\
\ charge that a discount applies to "
type: string
ChargeAmount:
description: " The amount being charged for the invoice item. This amount\
\ doesn't include taxes regardless if the charge's tax mode is inclusive\
\ or exclusive.\n\n\n**Character limit**:\n\n**Values**: automatically calculated\
\ from multiple fields in multiple objects "
format: double
type: number
ChargeDate:
description: " The date when the Invoice Item is created .\n\n\n**Character\
\ limit**: 29\n\n**Values**: automatically generated "
format: date-time
type: string
ChargeDescription:
description: " A description of the invoice item's charge.\n\n\n**Character\
\ limit**: 500\n\n**Values**: inherited from `RatePlanCharge.Description` "
type: string
ChargeId:
description: " The ID of the rate plan charge that is associated with this\
\ invoice item upon object creation.\n\n\n**Character limit**: 32\n\n**Values**:\
\ inherited from `RatePlanCharge.Id` "
type: string
ChargeName:
description: " The name of the invoice item's charge.\n**Character limi**t:\
\ 50\n\n**Values: **inherited from `RatePlanCharge.Name` "
type: string
ChargeNumber:
description: " The unique identifier of the invoice item's charge.\n\n\n**Character\
\ limit:** 50\n\n**Values:** inherited from `RatePlanCharge.ChargeNumber` "
type: string
ChargeType:
description: |2
Specifies the type of charge.
**Character limit**: 9
**Values**: one of the following:
- `OneTime`
- `Recurring`
- `Usage`
type: string
CreatedById:
description: " The user ID of the person who created the invoice item.\n\n\
\n**Character limit**: 32\n\n**Values**: automatically generated "
type: string
CreatedDate:
description: " The date the invoice item was created.\n\n\n**Character limit:**\
\ 29\n\n**Values**: automatically generated "
format: date-time
type: string
InvoiceId:
description: " The ID of the invoice that's associated with this invoice item.\n\
\n\n**Character limit**: 32\n\n**Values**: inherited from `Invoice.Id` "
type: string
ProcessingType:
description: |2
Identifies the kind of charge where 0 is a charge, 1 is a discount, 2 is a prepayment, and 3 is a tax. The returned value is text not decimal on data sources.
**Character limit**:
**Values: **
- 0: charge
- 1: discount
- 2: prepayment
- 3: tax
format: double
type: number
ProductDescription:
description: " A description of the product associated with this invoice item.\n\
\n\n**Character limit**: 500\n\n**Values**: inherited from `Product.Description` "
type: string
ProductId:
description: " The ID of the product associated with this invoice item.\n\n\
\n**Character limit**: 32\n\n**Values**: inherited from `Product.Id` "
type: string
ProductName:
description: " The name of the product associated with this invoice item.\n\
\n\n**Character limit**: 255\n\n**Values: **inherited from `Product.Name` "
type: string
ProductRatePlanChargeId:
description: |2-
The ID of the rate plan charge that's associated with this invoice item.
**Character limit**: 32
**Values**: inherited from `ProductRatePlanCharge.Id` You cannot query for this field. Only the subscribe preview and the amend preview calls will return the value of this field in the response.
type: string
Quantity:
description: " The number of units for this invoice item.\n\n\n**Values**:\
\ inherited from `RatePlanCharge.Quantity` "
format: double
type: number
RatePlanChargeId:
description: " The ID of the rate plan charge that's associated with this\
\ invoice item.\n\n\n**Character limit**: 32\n\n**Values**: inherited from\
\ `RatePlanCharge.Id` "
type: string
RevRecCode:
description: " Associates this invoice item with a specific revenue recognition\
\ code.\n\n\n**Character limit**: 32\n\n**Values**: inherited from `ProductRatePlanCharge.RevRecCode` "
type: string
RevRecStartDate:
description: " The date when revenue recognition is triggered.\n\n\n**Character\
\ limit**: 29\n\n**Values**: generated from `InvoiceItem.RevRecTriggerCondition` "
format: date
type: string
RevRecTriggerCondition:
description: " Specifies when revenue recognition begins based on a triggering\
\ event.\n\n\n**Character limit**:\n\n**Values**: inherited from `ProductRatePlanCharge`.`RevRecTriggerCondition` "
type: string
SKU:
description: " The unique SKU for the product associated with this invoice\
\ item.\n\n\n**Character limit**: 255\n\n**Values**: inherited from `Product.SKU` "
type: string
ServiceEndDate:
description: " The end date of the service period associated with this invoice\
\ item. Service ends one second before the date in this value.\n\n\n**Character\
\ limit**: 29\n\n**Values**: automatically generated "
format: date
type: string
ServiceStartDate:
description: " The start date of the service period associated with this invoice\
\ item. If the associated charge is a one-time fee, then this date is the\
\ date of that charge.\n\n\n**Character limit:** 29\n\n**Values**: automatically\
\ generated "
format: date
type: string
SubscriptionId:
description: " The ID of the subscription associated with the invoice item.\n\
\n\n**Character limit**: 32\n\n**Values**: inherited from `Subscription.Id` "
type: string
SubscriptionNumber:
description: " The number of the subscription associated with the invoice\
\ item.\n\n\n**Character limit**:\n\n**Values**: "
type: string
TaxAmount:
description: " The amount of tax applied to the invoice item's charge.\n\n\
\n**Character limit**:\n\n**Values**: calculated from multiple fields in\
\ the ProductRatePlanCharge object "
format: double
type: number
TaxCode:
description: " Specifies the tax code for taxation rules.\n\n\n**Character\
\ limit**: 6\n\n**Values**: inherited from `ProductRatePlanCharge.TaxCode` "
type: string
TaxExemptAmount:
description: " The calculated tax amount excluded due to the exemption.\n\n\
\n**Character limit**:\n\n**Values**: calculated from multiple fields in\
\ the ProductRatePlanCharge object "
format: double
type: number
TaxMode:
description: " The tax mode of the invoice item.\n\n\n**Character limit**:\
\ 12\n\n**Values**: `TaxExclusive`, `TaxInclusive` "
type: string
UOM:
description: " Specifies the units to measure usage. Units of measure are\
\ configured in the web-based UI: **Z-Billing > Settings**\n\n**Character\
\ limit**:\n\n**Values**: inherited from `ProductRatePlanCharge.UOM` "
type: string
UnitPrice:
description: " The per-unit price of the invoice item.\n\n\n**Character limit**:\n\
\n**Values**: calculated from multiple fields in ProductRatePlanCharge and\
\ ProductRatePlanChargeTier objets "
format: double
type: number
UpdatedById:
description: " The ID of the user who last updated the invoice item.\n\n\n\
**Character limit**: 32\n\n**Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the invoice item was last updated.\n\n\n**Character\
\ limit**: 29\n\n**Values**: automatically generated "
format: date-time
type: string
type: object
ActionAmendSubscriptionProductFeature:
allOf:
- properties:
CreatedById:
description: ''
type: string
CreatedDate:
description: " Date and time when the product feature was added to the subscription.\n\
\n\n**Character limit**: 29\n\n**Values**: "
format: date-time
type: string
Description:
description: " Description of the subscription product feature.\n\n\n**Character\
\ limit**: 500\n\n**Values**: "
type: string
FeatureCode:
description: " Unique code of the feature.\n\n\n**Character limit**: 255\n\
\n**Values**: "
type: string
FeatureId:
description: " Internal Zuora ID of the feature.\n\n\n**Character limit**:\
\ 32\n\n**Values**: "
type: string
Name:
description: " Name of the feature.\n\n\n**Character limit**: 255\n\n**Values**: "
type: string
RatePlanId:
description: " Id of the product rate plan to which the feature belongs.\n\
\n\n**Character limit**: 32\n\n**Values**: "
type: string
UpdatedById:
description: " Internal Zuora ID of the user who last updated the subscription\
\ product feature.\n\n\n**Character limit**: 32\n\n**Values**: "
type: string
UpdatedDate:
description: " Date and time when the subscription product feature was last\
\ updated.\n\n\n**Character limit**: 29\n\n**Values**: "
format: date-time
type: string
type: object
- $ref: '#/definitions/SubscriptionObjectCustomFields'
ActionSubscribeCreditMemo:
description: |
Container for credit memos.
**Note**: This field is only available if you have the Invoice Settlement feature enabled and set the `X-Zuora-WSDL-Version` request header to `107` or later.
properties:
TaxAmount:
description: 'Tax amount on the credit memo.
'
format: double
type: number
TotalAmount:
description: 'Credit memo amount.
'
format: double
type: number
TotalAmountWithoutTax:
description: 'Credit memo amount minus tax.
'
format: double
type: number
title: CreditMemo
type: object
ActionSubscribeCreditMemoData:
properties:
CreditMemo:
$ref: '#/definitions/ActionSubscribeCreditMemo'
CreditMemoItem:
description: ''
items:
$ref: '#/definitions/ActionSubscribeCreditMemoItem'
type: array
TaxationItemData:
description: "List of taxation items.\n \n**Note**: This field is only available\
\ if you set the `X-Zuora-WSDL-Version` request header to `120` or later.\n"
items:
properties:
CreditMemoItemId:
description: 'The ID of the credit memo item associated with the taxation
item.
'
type: string
ExemptAmount:
description: 'The calculated tax amount excluded due to the exemption.
'
type: number
Jurisdiction:
description: 'The jurisdiction that applies the tax or VAT. This value
is typically a state, province, county, or city.
'
type: string
LocationCode:
description: 'The identifier for the location based on the value of
the TaxCode field.
'
type: string
Name:
description: 'The name of the taxation item.
'
type: string
TaxAmount:
description: 'The amount of the tax applied to the credit memo.
'
type: number
TaxCode:
description: 'The tax code identifies which tax rules and tax rates
to apply to a specific credit memo.
'
type: string
TaxCodeDescription:
description: 'The description of the tax code.
'
type: string
TaxDate:
description: 'The date when the tax is applied to the credit memo.
'
type: string
TaxRate:
description: 'The tax rate applied to the credit memo.
'
type: number
TaxRateDescription:
description: 'The description of the tax rate.
'
type: string
TaxRateType:
description: 'The type of the tax rate applied to the credit memo.
'
enum:
- Percentage
- FlatFee
type: string
type: object
type: array
title: CreditMemoData
type: object
ActionSubscribeCreditMemoItem:
properties:
AmountWithoutTax:
description: 'The credit memo item amount excluding tax.
'
format: double
type: number
ChargeName:
description: 'Name of this credit memo item.
'
type: string
Description:
description: 'Description of this credit memo item.
'
type: string
ProductRatePlanChargeId:
description: 'ID of the product rate plan charge associated with this credit
memo item.
'
type: string
Quantity:
description: 'Quantity of the charge associated with this credit memo item.
'
type: integer
ServiceEndDate:
description: 'End date of the service period for this credit memo item, as
yyyy-mm-dd.
'
format: date
type: string
ServiceStartDate:
description: 'Service start date of this credit memo item, as yyyy-mm-dd.
'
format: date
type: string
TaxAmount:
description: 'The tax amount of the credit memo item.
'
format: double
type: number
UnitOfMeasure:
description: 'Unit used to measure consumption.
'
type: string
title: CreditMemoItem
type: object
ActionSubscribeInvoiceData:
properties:
Invoice:
$ref: '#/definitions/InvoiceDataInvoice'
InvoiceItem:
description: ''
items:
$ref: '#/definitions/ActionSubscribeInvoiceItem'
type: array
TaxationItemData:
description: "List of taxation items.\n \n**Note**: This field is only available\
\ if you set the `X-Zuora-WSDL-Version` request header to `120` or later.\n"
items:
properties:
ExemptAmount:
description: 'The calculated tax amount excluded due to the exemption.
'
type: number
InvoiceItemId:
description: 'The ID of the invoice item associated with the taxation
item.
'
type: string
Jurisdiction:
description: 'The jurisdiction that applies the tax or VAT. This value
is typically a state, province, county, or city.
'
type: string
LocationCode:
description: 'The identifier for the location based on the value of
the TaxCode field.
'
type: string
Name:
description: 'The name of the taxation item.
'
type: string
TaxAmount:
description: 'The amount of the tax applied to the invoice.
'
type: number
TaxCode:
description: 'The tax code identifies which tax rules and tax rates
to apply to a specific invoice.
'
type: string
TaxCodeDescription:
description: 'The description of the tax code.
'
type: string
TaxDate:
description: 'The date when the tax is applied to the invoice.
'
type: string
TaxRate:
description: 'The tax rate applied to the invoice.
'
type: number
TaxRateDescription:
description: 'The description of the tax rate.
'
type: string
TaxRateType:
description: 'The type of the tax rate applied to the invoice.
'
enum:
- Percentage
- FlatFee
type: string
type: object
type: array
type: object
ActionSubscribeInvoiceItem:
allOf:
- properties:
AccountingCode:
description: " The accounting code for the item's charge. Accounting codes\
\ group transactions that contain similar accounting attributes.\n\n\n\
**Character limit**: 100\n\n\n**Values**: inherited from `RatePlanCharge.AccountingCode` "
type: string
AppliedToChargeNumber:
description: " The charge number that the discount charge is applied to.\
\ This field is only for the invoice items that are discount charges.\
\ This field is only returned in subscription previews.\nThis field will\
\ be returned in the response if you specify the charge number in the\
\ rate plan charges in the request.\n\n**Character limit**: 32\n\n**Values**:\
\ inherited from `RatePlanCharge.ChargeNumber` for the charge associated\
\ with the invoice item that the discount charge is applied to "
type: string
AppliedToInvoiceItemId:
description: " Associates a discount invoice item to a specific invoice\
\ item.\n\n**Character limit**: 32\n\n**Values**: inherited from the ID\
\ of the charge that a discount applies to "
type: string
ChargeAmount:
description: " The amount being charged for the invoice item. This amount\
\ doesn't include taxes regardless if the charge's tax mode is inclusive\
\ or exclusive.\n\n\n**Character limit**:\n\n\n**Values**: automatically\
\ calculated from multiple fields in multiple objects "
format: double
type: number
ChargeDate:
description: " The date when the Invoice Item is created .\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
ChargeDescription:
description: " A description of the invoice item's charge.\n\n\n**Character\
\ limit**: 500\n\n\n**Values**: inherited from `RatePlanCharge.Description` "
type: string
ChargeId:
description: " The ID of the rate plan charge that is associated with this\
\ invoice item upon object creation.\n\n\n**Character limit**: 32\n\n\n\
**Values**: inherited from `RatePlanCharge.Id` "
type: string
ChargeName:
description: " The name of the invoice item's charge.\n**Character limi**t:\
\ 50 **Values: **inherited from `RatePlanCharge.Name` "
type: string
ChargeNumber:
description: " The unique identifier of the invoice item's charge.\n**Character\
\ limit:** 50 **Values:** inherited from `RatePlanCharge.ChargeNumber` "
type: string
ChargeType:
description: |2
Specifies the type of charge.
**Character limit**: 9
**Values**: one of the following:
- `OneTime`
- `Recurring`
- `Usage`
type: string
CreatedById:
description: " The user ID of the person who created the invoice item.\n\
\n\n**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
CreatedDate:
description: " The date the invoice item was created.\n**Character limit:**\
\ 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
InvoiceId:
description: " The ID of the invoice that's associated with this invoice\
\ item.\n\n\n**Character limit**: 32\n\n\n**Values**: inherited from `Invoice.Id` "
type: string
ProcessingType:
description: |2
Identifies the kind of charge where 0 is a charge, 1 is a discount, 2 is a prepayment, and 3 is a tax. The returned value is text not decimal on data sources.
**Character limit**: **Values: **
- 0: charge
- 1: discount
- 2: prepayment
- 3: tax
format: double
type: number
ProductDescription:
description: " A description of the product associated with this invoice\
\ item.\n\n\n**Character limit**: 500\n\n\n**Values**: inherited from\
\ `Product.Description` "
type: string
ProductId:
description: " The ID of the product associated with this invoice item.\n\
\n\n**Character limit**: 32\n\n\n**Values**: inherited from `Product.Id` "
type: string
ProductName:
description: " The name of the product associated with this invoice item.\n\
\n\n**Character limit**: 255 **Values: **inherited from `Product.Name` "
type: string
ProductRatePlanChargeId:
description: |2-
The ID of the rate plan charge that's associated with this invoice item.
**Character limit**: 32
**Values**: inherited from `ProductRatePlanCharge.Id` You cannot `query
` for this field. Only the s`ubscribe
` preview and the `amend
` preview calls will return the value of this field in the response.
type: string
Quantity:
description: " The number of units for this invoice item.\n\n\n\n**Values**:\
\ inherited from `RatePlanCharge.Quantity` "
format: double
type: number
RatePlanChargeId:
description: " The ID of the rate plan charge that's associated with this\
\ invoice item.\n\n\n**Character limit**: 32\n\n\n**Values**: inherited\
\ from `RatePlanCharge.Id` "
type: string
RevRecCode:
description: " Associates this invoice item with a specific revenue recognition\
\ code.\n\n\n**Character limit**: 32\n\n\n**Values**: inherited from `ProductRatePlanCharge.RevRecCode` "
type: string
RevRecStartDate:
description: " The date when revenue recognition is triggered.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: generated from `InvoiceItem.RevRecTriggerCondition` "
format: date
type: string
RevRecTriggerCondition:
description: " Specifies when revenue recognition begins based on a triggering\
\ event.\n\n\n**Character limit**:\n\n\n**Values**: inherited from `ProductRatePlanCharge`.`RevRecTriggerCondition` "
type: string
SKU:
description: " The unique SKU for the product associated with this invoice\
\ item.\n\n\n**Character limit**: 255\n\n\n**Values**: inherited from\
\ `Product.SKU` "
type: string
ServiceEndDate:
description: " The end date of the service period associated with this invoice\
\ item. Service ends one second before the date in this value.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date
type: string
ServiceStartDate:
description: " The start date of the service period associated with this\
\ invoice item. If the associated charge is a one-time fee, then this\
\ date is the date of that charge.\n**Character limit:** 29\n\n\n**Values**:\
\ automatically generated "
format: date
type: string
SubscriptionId:
description: " The ID of the subscription associated with the invoice item.\n\
\n\n**Character limit**: 32\n\n\n**Values**: inherited from `Subscription.Id` "
type: string
SubscriptionNumber:
description: " The number of the subscription associated with the invoice\
\ item.\n\n\n**Character limit**:\n\n\n**Values**: "
type: string
TaxAmount:
description: " The amount of tax applied to the invoice item's charge.\n\
\n\n**Character limit**:\n\n\n**Values**: calculated from multiple fields\
\ in the ProductRatePlanCharge object "
format: double
type: number
TaxCode:
description: " Specifies the tax code for taxation rules.\n\n\n**Character\
\ limit**: 6\n\n\n**Values**: inherited from `ProductRatePlanCharge.TaxCode` "
type: string
TaxExemptAmount:
description: " The calculated tax amount excluded due to the exemption.\n\
\n\n**Character limit**:\n\n\n**Values**: calculated from multiple fields\
\ in the ProductRatePlanCharge object "
format: double
type: number
TaxMode:
description: " The tax mode of the invoice item.\n\n\n**Character limit**:\
\ 12\n\n\n**Values**: `TaxExclusive`, `TaxInclusive` "
type: string
UOM:
description: " Specifies the units to measure usage. Units of measure are\
\ configured in the web-based UI: **Z-Billing > Settings**\n\n**Character\
\ limit**:\n\n\n**Values**: inherited from `ProductRatePlanCharge.UOM` "
type: string
UnitPrice:
description: " The per-unit price of the invoice item.\n\n\n**Character\
\ limit**:\n\n\n**Values**: calculated from multiple fields in ProductRatePlanCharge\
\ and ProductRatePlanChargeTier objets "
format: double
type: number
UpdatedById:
description: " The ID of the user who last updated the invoice item.\n\n\
\n**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the invoice item was last updated.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
type: object
- $ref: '#/definitions/InvoiceItemObjectNSFields'
- $ref: '#/definitions/InvoiceItemObjectCustomFields'
ActionsErrorResponse:
properties:
Code:
description: ''
type: string
Message:
description: ''
type: string
type: object
AmendRequest:
properties:
AmendOptions:
description: 'Use the `AmendOptions` container to specify billing options,
such as invoice generation and when to process payments.
'
properties:
ApplicationOrder:
description: |
The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.
**Note:**
- This field is only available if you have the Invoice Settlement feature enabled and set the `X-Zuora-WSDL-Version` request header to `107` or later.
- This field is valid only if the `applyCredit` field is set to `true`.
- If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
- If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices.
items:
type: string
type: array
ApplyCredit:
description: |
If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.
**Note**: This field is only available if you have the Invoice Settlement feature enabled and set the `X-Zuora-WSDL-Version` request header to `107` or later.
type: boolean
ApplyCreditBalance:
description: ''
type: boolean
ElectronicPaymentOptions:
$ref: '#/definitions/ElectronicPaymentOptions'
ExternalPaymentOptions:
$ref: '#/definitions/ExternalPaymentOptions'
GenerateInvoice:
description: "Determines whether to generate an invoice to immediately\
\ bill the customer for a new product or changes of Terms And Conditions.\
\ As a best practice, set this value to true to prevent any errors that\
\ might occur if the account has a balance.\n\n**Note:** \n* Even if\
\ you do not include this field in the amend action, Zuora still parses\
\ this field with the default value - `true`, when processing the amend\
\ action. If you do not want to generate the invoice after creating\
\ the New Product or Term And Condition amendment, set the value of\
\ this field to `false` in the request.\n* If `EnablePreviewMode=true`\
\ is specified in the PreviewOptions container, then preview mode will\
\ be enabled and an invoice will not be generated, regardless of whether\
\ `GenerateInvoice` is specified as `true` or `false`.\n"
type: boolean
InvoiceProcessingOptions:
$ref: '#/definitions/InvoiceProcessingOptions'
ProcessPayments:
description: "Determines whether to collect payment against the invoice\
\ generated by the amend() call. \n\n**Note:** \n* Even if you do not\
\ include this field in the amend action, Zuora still parses this field\
\ with the default value, true, when processing the amend action. If\
\ you do not want to collect payment against the generated invoice after\
\ creating the New Product or Term And Condition amendment, set the\
\ value of this field to `false` in the request. \nIf a temporary error that Zuora cannot\
\ create or submit a payment to the gateway is seen, Zuora will automatically\
\ retry the action to collect the payment.\n\nYou can contact [Zuora\
\ Global Support](https://support.zuora.com/) to set the maximum number\
\ of retries that Zuora can perform. The number can range from 0 to\
\ 2 with a default value of 0. However, retrying the request can make\
\ the API call take longer than expected. Zuora does not guarantee the\
\ retry could be completed within the timeout limit. \n\n**Note**: The\
\ retry mechanism does not support the preview mode of the amend() call.\n"
type: boolean
type: object
Amendments:
description: "The `Amendment` object holds the changes that you want to make\
\ to the Subscription specified by the `SubscriptionId`, \nincluding its\
\ `RatePlan`, `RatePlanCharge`, and `RatePlanChargeTier`.\n"
items:
$ref: '#/definitions/Amendment'
type: array
PreviewOptions:
description: "Use the `PreviewOptions` container to preview an amendment before\
\ committing its changes to a subscription. \nYou can use a preview to provide\
\ a quote of the new charges to a customer before the customer commits to\
\ the amended subscription. \nFor example, make an Amend call with an Amendment\
\ object that removes an existing rate plan, \nanother Amendment object\
\ that adds a new rate plan, and turn on the preview options.\n"
properties:
EnablePreviewMode:
description: ' Determines whether to create an amendment or display a
preview of the change.'
type: boolean
IncludeExistingDraftInvoiceItems:
description: ' Specifies whether to include draft invoice items in amendment
previews.'
type: boolean
NumberOfPeriods:
description: ' Indicates the number of invoice periods to show in a preview.'
format: int32
type: integer
PreviewThroughTermEnd:
description: ' Request to preview the charge through the end of the subscription
term.'
type: boolean
PreviewType:
description: ' The type of preview you will receive from a preview request.'
type: string
type: object
required:
- Amendments
type: object
AmendResult:
properties:
AmendmentIds:
description: 'A list of the IDs of the associated amendments. There can be
as many as three amendment IDs. Use a comma to separate each amendment ID.
'
items:
type: string
type: array
ChargeMetricsData:
$ref: '#/definitions/ChargeMetricsData'
CreditMemoDatas:
description: ''
items:
$ref: '#/definitions/ActionAmendCreditMemoData'
type: array
CreditMemoId:
description: ''
type: string
Errors:
description: ''
items:
$ref: '#/definitions/ActionsErrorResponse'
type: array
GatewayResponse:
description: ''
type: string
GatewayResponseCode:
description: ''
type: string
InvoiceDatas:
description: 'This array of invoices contains one invoice only as one invoice
is generated for one subscription.
'
items:
$ref: '#/definitions/ActionAmendInvoiceData'
type: array
InvoiceId:
description: ''
type: string
PaymentId:
description: ''
type: string
PaymentTransactionNumber:
description: ''
type: string
SubscriptionId:
description: ''
type: string
Success:
description: ''
type: boolean
TotalDeltaMrr:
description: "`TotalDeltaMrr` is calculated by the following formula:\n\n\
\ TotalDeltaMrr = newSubscription.CMRR - originalSubscription.CMRR\n\n See\
\ [here](https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_How_to_Manage_Customer_Accounts/E_Key_Metrics/B_Monthly_Recurring_Revenue#Contracted_MRR)\
\ for the definition of CMRR. The new subscriptin represents the later version\
\ of an subscription after an amendment. The original subscription represents\
\ the original version of the subscription before the amendment. \n"
format: double
type: number
TotalDeltaTcv:
description: ''
format: double
type: number
type: object
Amendment:
properties:
AutoRenew:
description: " Determines whether the subscription is automatically renewed,\
\ or whether it expires at the end of the term and needs to be manually\
\ renewed. For amendment of type `TermsAndConditions`, this field is only\
\ required if you change the automatic renewal status of a subscription.\n\
\n\n**Values**: true, false "
type: boolean
Code:
description: |2
A unique alphanumeric string that identifies the amendment.
**Character limit**: 50
**Values**: automatically generated
type: string
ContractEffectiveDate:
description: ' The date when the amendment''s changes become effective for
billing purposes.
'
format: date
type: string
CreatedById:
description: " The user ID of the person who created the amend