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 amendment.\n\n\n\
**Character limit**: 32\n\n**Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the amendment was created.\n\n\n**Values**: automatically\
\ generated "
format: date-time
type: string
CurrentTerm:
description: " The length of the period for the current subscription term.\
\ This field can be updated when Status is `Draft`.\n\nThis field is only\
\ required if the `Type` field is set to `TermsAndConditions` and `TermType`\
\ is set to `TERMED`. This field is not required if `TermType` is set to\
\ `EVERGREEN`.\n\n\n**Values**: a valid number "
format: int64
type: integer
CurrentTermPeriodType:
description: |2
The period type for the current subscription term. This field is only required if the `Type` field is set to `TermsAndConditions` and `TermType` is set to `TERMED`. This field is not required if `TermType` is set to `EVERGREEN`.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
**Note**:
- This field can be updated when Status is `Draft`.
- This field is used with the CurrentTerm field to specify the current subscription term.
type: string
CustomerAcceptanceDate:
description: |
The date when the customer accepts the amendment's changes to the subscription.
This field is only required if [Zuora is configured to require customer acceptance in Z-Billing](https://knowledgecenter.zuora.com/CB_Billing/W_Billing_and_Payments_Settings/Define_Default_Subscription_Settings) and the subscription is currently in the Pending Acceptance status (the value of the `Status` field is currently `PendingAcceptance`).
Use this field together with the `Status` field. When you set a date in this field as a customer acceptance date, you should also set the `Status` field as `Completed`.
format: date
type: string
Description:
description: " A description of the amendment.\n\n\n**Character limit**: 500\n\
\n**Values**: maximum 500 characters "
type: string
DestinationAccountId:
description: " The ID of the subscription owner that the subscription is being\
\ transferred to.\n\n\n**Character limit**: 32\n\n**Values**: a valid account\
\ ID "
type: string
DestinationInvoiceOwnerId:
description: " The ID of the invoice owner that the subscription is being\
\ transferred to.\n\n\n**Character limit**: 32\n\n**Values**: a valid invoice\
\ ID "
type: string
EffectiveDate:
description: |2+
The date when the amendment's changes take effective. This field validates that the amendment's changes are within valid ranges of products and product rate plans.
This field is only required if the `Type` field is set to `Cancellation`.
format: date
type: string
ExternallyManagedBy:
description: 'An enum field on the Subscription object to indicate the name
of a third-party store. This field is used to represent subscriptions created
through third-party stores.
'
enum:
- Amazon
- Apple
- Google
- Roku
type: string
Name:
description: " The name of the amendment.\n\n\n**Character limit**: 100\n\n\
**Values**: a string of 100 characters or fewer "
type: string
RatePlanData:
description: 'A container for one `RatePlanData`. This field is only required
if the `Type` field is set to `NewProduct`, `RemoveProduct`, or `UpdateProduct`.
'
properties:
RatePlan:
$ref: '#/definitions/RatePlan'
RatePlanChargeData:
description: ''
items:
$ref: '#/definitions/RatePlanChargeDataInRatePlanData'
type: array
SubscriptionProductFeatureList:
$ref: '#/definitions/SubscriptionProductFeatureList'
required:
- RatePlan
type: object
RenewalSetting:
description: " Specifies whether a termed subscription will remain termed\
\ or change to evergreen when it is renewed.\n\nThis field is only required\
\ if the `TermType` field is set to `Termed`.\n\n\n**Values**: RENEW_WITH_SPECIFIC_TERM\
\ (default), RENEW_TO_EVERGREEN "
type: string
RenewalTerm:
description: " The term of renewal for the amended subscription. This field\
\ can be updated when Status is `Draft`.\nThis field is only required if\
\ the `Type` field is set to `TermsAndConditions`.\n\n\n**Values:** a valid\
\ number "
format: int64
type: integer
RenewalTermPeriodType:
description: |2
The period type for the subscription renewal term. This field can be updated when Status is `Draft`.
**Required**: Only if the value of the Type field is set to `TermsAndConditions`. This field is used with the RenewalTerm field to specify the subscription renewal term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
type: string
ResumeDate:
description: |
The date when the subscription resumption takes effect. See [Resume Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Resume_a_Subscription#Resume_Date) for more information.
This field is only required if you resume a suspended subscription.
format: date
type: string
ServiceActivationDate:
description: |
The date when service is activated.
This field is only required if [Zuora is configured to require service activation in Z-Billing](https://knowledgecenter.zuora.com/CB_Billing/W_Billing_and_Payments_Settings/Define_Default_Subscription_Settings) and the subscription is currently in the Pending Activation status (the value of the `Status` field is currently `PendingActivation`).
Use this field together with the `Status` field. When you set a date in this field as a service activation date, you should also set the `Status` field as the expected next phase status: `Completed` or `PendingAcceptance`.
format: date
type: string
SpecificUpdateDate:
description: |
The date when the UpdateProduct amendment takes effect. This field is only applicable if there is already a future-dated UpdateProduct amendment on the subscription.
For the UpdateProduct amendments, this field is only required if there is already a future-dated UpdateProduct amendment on the subscription.
format: date
type: string
Status:
description: |2
The status of the amendment. Type: string (enum)
**Values**: one of the following:
- Draft (default, if left null)
- Pending Activation
- Pending Acceptance
- Completed
type: string
SubscriptionId:
description: " The ID of the subscription that the amendment changes. The\
\ ID can be the latest version or any history version of ID.\n\n\n**Character\
\ limit**: 32\n\n**Values**: a valid subscription ID "
type: string
SuspendDate:
description: |
The date when the subscription suspension takes effect. See [Suspend Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Suspend_a_Subscription#Suspend_Date) for more information.
This field is only required if you suspend an active subscription.
format: date
type: string
TermStartDate:
description: |2
The date when the new terms and conditions take effect.
This field is only required if the `Type` field is set to `TermsAndConditions`.
format: date
type: string
TermType:
description: " Indicates if the subscription isTERMED or EVERGREEN.\n\n- A\
\ TERMED subscription has an expiration date, and must be manually renewed.\n\
- An EVERGREEN subscription doesn't have an expiration date, and must be\
\ manually ended.\n\nWhen as part of an amendment of type `TermsAndConditions`,\
\ this field is required to change the term type of a subscription.\n\n\n\
**Character limit**: 9\n\n**Values**: TERMED, EVERGREEN "
type: string
Type:
description: |2
The type of amendment.
**Character limit**: 20
**Values**: one of the following:
- Cancellation
- NewProduct
- OwnerTransfer (If this value is chosen, the `ContractEffectiveDate`, `ServiceActivationDate`, and `CustomerAcceptanceDate` fields will all be automatically set to today's date, and any values passed from the API are ignored.)
- RemoveProduct
- Renewal
- UpdateProduct
- TermsAndConditions
- SuspendSubscription
- ResumeSubscription
type: string
UpdatedById:
description: " The ID of the user who last updated the amendment.\n\n\n**Character\
\ limit**: 32\n\n**Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the amendment was last updated.\n\n\n**Values**:\
\ automatically generated "
format: date-time
type: string
BookingDate:
description: |
The date when the amendment is signed. If you didn't specify this field, the date is automatically set to the amendment created-on date.
This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.
**Note:** This field is only available if you set the `X-Zuora-WSDL-Version` header parameter to `120` or later.
format: date
type: string
required:
- SubscriptionId
- Type
- ContractEffectiveDate
- Name
type: object
AmendmentObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Amendment 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 Amendment object.
'
title: amendmentFieldsCustom
type: object
BillToContact:
allOf:
- description: 'Contact details associated with an account.
'
properties:
address1:
description: 'First line of the contact''s address. This is often a street
address or a business name.
'
maxLength: 255
type: string
address2:
description: 'Second line of the contact''s address.
'
maxLength: 255
type: string
city:
description: 'City of the contact''s address.
'
maxLength: 40
type: string
country:
description: 'Country; must be a valid country name or abbreviation. If
using Zuora Tax, you must specify a country in the bill-to contact to
calculate tax.
'
maxLength: 64
type: string
county:
description: 'County of the contact''s address.
'
maxLength: 32
type: string
fax:
description: 'Fax number of the contact.
'
maxLength: 40
type: string
firstName:
description: 'First name of the contact.
'
maxLength: 100
type: string
homePhone:
description: 'Home phone number of the contact.
'
maxLength: 40
type: string
lastName:
description: 'Last name of the contact.
'
maxLength: 100
type: string
mobilePhone:
description: 'Mobile phone number of the contact.
'
maxLength: 40
type: string
nickname:
description: 'Nickname of the contact.
'
maxLength: 100
type: string
otherPhone:
description: 'Additional phone number of the contact. Use the `otherPhoneType`
field to specify the type of phone number.
'
maxLength: 40
type: string
otherPhoneType:
description: 'Specifies the type of phone number in the `otherPhone` field.
'
enum:
- Work
- Mobile
- Home
- Other
type: string
personalEmail:
description: 'Personal email address of the contact.
'
format: email
maxLength: 80
type: string
postalCode:
description: 'ZIP code or other postal code of the contact''s address.
'
maxLength: 20
type: string
state:
description: 'State or province of the contact''s address.
'
maxLength: 40
type: string
taxRegion:
description: 'Region defined in your taxation rules. Only applicable if
you use Zuora Tax.
'
maxLength: 32
type: string
workEmail:
description: 'Business email address of the contact.
'
format: email
maxLength: 80
type: string
workPhone:
description: 'Business phone number of the contact.
'
maxLength: 40
type: string
required:
- firstName
- lastName
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
BillingUpdate:
properties:
billingPeriodAlignment:
enum:
- AlignToCharge
- AlignToSubscriptionStart
- AlignToTermStart
type: string
type: object
CancelSubscription:
description: 'Information about an order action of type `CancelSubscription`.
'
properties:
cancellationEffectiveDate:
format: date
type: string
cancellationPolicy:
enum:
- EndOfCurrentTerm
- EndOfLastInvoicePeriod
- SpecificDate
type: string
required:
- cancellationPolicy
title: cancelSubscription
type: object
ChangePlan:
description: |
Information about an order action of type `ChangePlan`.
**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.
properties:
effectivePolicy:
description: |
* If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.
* If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.
* Otherwise, the effective policy is `SpecificDate` by default.
enum:
- EffectiveImmediately
- EffectiveEndOfBillingPeriod
- SpecificDate
type: string
newProductRatePlan:
$ref: '#/definitions/ChangePlanRatePlanOverride'
productRatePlanId:
description: 'ID of the rate plan to remove. This can be the latest version
or any history version of ID.
'
type: string
ratePlanId:
description: 'ID of the rate plan to remove. This can be the latest version
or any history version of ID.
'
type: string
subType:
description: |
This field is used to choose the sub type for your change plan order action.
However, if you do not set this field, the field will be automatically generated by the system according to the following rules:
When the old and new rate plans are within the same Grading catalog group:
* If the grade of new plan is greater than that of the old plan, this is an "Upgrade".
* If the grade of new plan is less than that of the old plan, this is a "Downgrade".
* If the grade of new plan equals that of the old plan, this is a "Crossgrade".
When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is "PlanChanged".
enum:
- Upgrade
- Downgrade
- Crossgrade
- PlanChanged
type: string
title: changePlan
type: object
ChangePlanRatePlanOverride:
description: "Information about the new product rate plan to add. \n"
properties:
chargeOverrides:
description: 'List of charges associated with the rate plan.
'
items:
$ref: '#/definitions/CreateOrderChargeOverride'
type: array
clearingExistingFeatures:
description: 'Specifies whether all features in the rate plan will be cleared.
'
type: boolean
customFields:
$ref: '#/definitions/RatePlanObjectCustomFields'
externallyManagedPlanId:
description: 'Indicates the unique identifier for the rate plan purchased
on a third-party store. This field is used to represent a subscription rate
plan created through third-party stores.
'
type: string
productRatePlanId:
description: 'Internal identifier of the product rate plan that the rate plan
is based on.
'
type: string
subscriptionProductFeatures:
description: |
List of features associated with the rate plan.
The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:
* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.
* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
items:
$ref: '#/definitions/RatePlanFeatureOverride'
type: array
uniqueToken:
description: |
Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
maxLength: 50
type: string
title: ratePlan
type: object
ChargeMetricsData:
properties:
ChargeMetrics:
description: ''
items:
$ref: '#/definitions/NewChargeMetrics'
type: array
type: object
ChargeMetricsDiscountAllocationDetailResponse:
properties:
amendmentId:
description: 'The amendment id that result in the discount allocation detail
record.
'
type: string
amendmentType:
description: 'The ID of the corresponding amendment that result in the discount
allocation detail record.
'
type: string
chargeMetricsId:
description: 'The ID of the corresponding charge metrics record.
'
type: string
chargeNumber:
description: 'The corresponding charge number of the discount allocation details
record.
'
type: string
createdOn:
description: 'The date and time when the discount allocation detail record.
'
format: date-time
type: string
currency:
description: 'The currency of the discount allocation detail record.
'
type: string
deleted:
description: 'Whether the discount allocation detail record is deleted.
'
type: boolean
discountChargeNumber:
description: 'The number of the corresponding discount charge that leads to
the discount allocation detail record.
'
type: string
discountMrr:
description: |
The discount amount for the MRR of the discount allocation detail record.
See [Monthly Recurring Revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_How_to_Manage_Customer_Accounts/E_Key_Metrics/B_Monthly_Recurring_Revenue) for more MRR information.
type: number
discountTcv:
description: 'The discount amount for the TCV of the discount allocation detail
record.
'
type: number
endDate:
description: 'The end date of the discount allocation detail record.
'
format: date
type: string
id:
description: 'The ID of the discount allocation details record.
'
type: string
invoiceOwnerAccountNumber:
description: 'The account number of the corresponding invoice owner.
'
type: string
productId:
description: 'The corresponding product ID of the discount allocation details
record.
'
type: string
productRatePlanChargeId:
description: 'The corresponding product rate plan charge ID of the discount
allocation detail record.
'
type: string
productRatePlanId:
description: 'The corresponding product rate plan ID of the discount allocation
details record.
'
type: string
ratePlanChargeId:
description: 'The corresponding rate plan charge ID of the discount allocation
details record.
'
type: string
startDate:
description: 'The start date of the discount allocation detail record.
'
format: date
type: string
subscriptionName:
description: 'The name of the corresponding subscription.
'
type: string
subscriptionOwnerAccountNumber:
description: 'The account number of the corresponding subscription owner.
'
type: string
updatedOn:
description: 'The date and time when the discount allocation detail record.
'
format: date-time
type: string
type: object
ChargeMetricsResponse:
properties:
amendmentId:
description: 'The ID of the corresponding amendment that results in the charge
metrics record.
'
type: string
amendmentType:
description: 'The type of the corresponding amendment that results in the
charge metrics record.
'
type: string
chargeNumber:
description: 'The corresponding charge number of the charge metrics record.
'
type: string
createdOn:
description: 'The date and time when the charge metrics record was created,
in `yyyy-mm-ddThh:mm:ssZ` format.
'
format: date-time
type: string
currency:
description: 'The currency of the charge metrics record.
'
type: string
deleted:
description: 'Whether the charge metrics record is deleted.
'
type: boolean
endDate:
description: 'The end date of the charge metrics record.
'
format: date
type: string
id:
description: 'The ID of the charge metrics record.
'
type: string
invoiceOwnerAccountNumber:
description: 'The account number of the corresponding invoice owner.
'
type: string
mrrDiscountAmount:
description: |
The discount amount for the MRR.
See [Monthly Recurring Revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_How_to_Manage_Customer_Accounts/E_Key_Metrics/B_Monthly_Recurring_Revenue) for more MRR information.
type: number
mrrGrossAmount:
description: "The Gross MRR amount before discounts charges are applied. \n\
\nSee [Monthly Recurring Revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_How_to_Manage_Customer_Accounts/E_Key_Metrics/B_Monthly_Recurring_Revenue)\
\ for more MRR information.\n"
type: number
mrrNetAmount:
description: |
The NET MRR amount after discounts charges are applied.
See [Monthly Recurring Revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_How_to_Manage_Customer_Accounts/E_Key_Metrics/B_Monthly_Recurring_Revenue) for more MRR information.
type: number
productId:
description: 'The corresponding product ID of the charge metrics record.
'
type: string
productRatePlanChargeId:
description: 'The corresponding product rate plan charge ID of the charge
metrics record.
'
type: string
productRatePlanId:
description: 'The corresponding product rate plan ID of the charge metrics
record.
'
type: string
ratePlanChargeId:
description: 'The corresponding rate plan charge ID of the charge metrics
record.
'
type: string
startDate:
description: 'The start date of the charge metrics record.
'
format: date
type: string
subscriptionName:
description: 'The name of the corresponding subscription.
'
type: string
subscriptionOwnerAccountNumber:
description: 'The account number of the corresponding subscription owner.
'
type: string
tcvDiscountAmount:
description: 'The discount amount for the TCV.
'
type: number
tcvGrossAmount:
description: 'The Gross TCV amount before discount charges are applied.
'
type: number
tcvNetAmount:
description: 'The Net TCV amount after discount charges are applied.
'
type: number
updatedOn:
description: 'The date and time when the charge metrics record was last updated,
in `yyyy-mm-ddThh:mm:ssZ` format.
'
format: date-time
type: string
type: object
ChargeModelDataOverride:
description: |
Container for charge model configuration data.
**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.
properties:
chargeModelConfiguration:
properties:
customFieldPerUnitRate:
description: |
The custom field that carries the per-unit rate for each usage record. For example, `perUnitAmount__c`.
This field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.
type: string
customFieldTotalAmount:
description: "The custom field that carries the total amount to charge\
\ for a usage record. For example, `totalAmount__c`. \n\nThis field\
\ is only available for the usage-based charges that use the Pre-Rated\
\ Pricing charge model. The charge model is available for customers\
\ with Enterprise and Nine editions by default. If you are a Growth\
\ customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions)\
\ for pricing information.\n"
type: string
formula:
description: |
The pricing formula to calculate actual rating amount.
This field is only available for charges that use the Multi-Attribute Pricing charge model.
type: string
type: object
quantity:
description: |
Number of units purchased. This field is used if the Multi-Attribute Pricing formula uses the `quantity()` function.
This field is only available for one-time and recurring charges that use the Multi-Attribute Pricing charge model.
minimum: 0
type: number
tiers:
description: |
List of cumulative pricing tiers in the charge.
**Note**: When you override the tiers of a usage-based charge using High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.
items:
$ref: '#/definitions/ChargeTier'
type: array
title: chargeModelData
type: object
ChargeOverrideForEvergreen:
description: 'Charge associated with a rate plan.
'
properties:
billing:
description: 'Billing information about the charge.
'
properties:
billCycleDay:
description: 'Day of the month that each billing period begins on. Only
applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.
'
maximum: 31
minimum: 0
type: integer
billCycleType:
description: |
Specifies how Zuora determines the day that each billing period begins on.
* `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.
* `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.
* `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.
* `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.
* `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.
enum:
- DefaultFromCustomer
- SpecificDayofMonth
- SubscriptionStartDay
- ChargeTriggerDay
- SpecificDayofWeek
type: string
billingPeriod:
description: |
Billing frequency of the charge. The value of this field controls the duration of each billing period.
If the value of this field is `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.
enum:
- Month
- Quarter
- Semi_Annual
- Annual
- Eighteen_Months
- Two_Years
- Three_Years
- Five_Years
- Specific_Months
- Subscription_Term
- Week
- Specific_Weeks
type: string
billingPeriodAlignment:
description: |
Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.
* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.
* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.
* `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term.
See the `billCycleType` field for information about how Zuora determines the billing day.
enum:
- AlignToCharge
- AlignToSubscriptionStart
- AlignToTermStart
type: string
billingTiming:
description: 'Specifies whether to invoice for a billing period on the
first day of the billing period (billing in advance) or the first day
of the next billing period (billing in arrears).
'
enum:
- IN_ADVANCE
- IN_ARREARS
type: string
specificBillingPeriod:
description: 'Duration of each billing period in months or weeks, depending
on the value of the `billingPeriod` field. Only applicable if the value
of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.
'
type: integer
weeklyBillCycleDay:
description: 'Day of the week that each billing period begins on. Only
applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.
'
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
type: string
type: object
chargeNumber:
description: |
Charge number of the charge. For example, C-00000307.
If you do not set this field, Zuora will generate the charge number.
maxLength: 50
type: string
customFields:
$ref: '#/definitions/RatePlanChargeObjectCustomFields'
description:
description: 'Description of the charge.
'
maxLength: 500
type: string
endDate:
$ref: '#/definitions/EndConditions'
excludeItemBillingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charge related invoice items,\
\ invoice item adjustments, credit memo items, and debit memo items from\
\ revenue accounting.\n\n**Note**: This field is only available if you have\
\ the Billing - Revenue Integration feature enabled. \n"
type: boolean
excludeItemBookingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charges from revenue accounting.\n\
\n**Note**: This field is only available if you have the Billing - Revenue\
\ Integration feature enabled. \n"
type: boolean
pricing:
description: 'Pricing information about the charge.
'
properties:
chargeModelData:
$ref: '#/definitions/ChargeModelDataOverride'
discount:
$ref: '#/definitions/DiscountPricingOverride'
oneTimeFlatFee:
$ref: '#/definitions/OneTimeFlatFeePricingOverride'
oneTimePerUnit:
$ref: '#/definitions/OneTimePerUnitPricingOverride'
oneTimeTiered:
$ref: '#/definitions/OneTimeTieredPricingOverride'
oneTimeVolume:
$ref: '#/definitions/OneTimeVolumePricingOverride'
recurringFlatFee:
$ref: '#/definitions/RecurringFlatFeePricingOverride'
recurringPerUnit:
$ref: '#/definitions/RecurringPerUnitPricingOverride'
recurringTiered:
$ref: '#/definitions/RecurringTieredPricingOverride'
recurringVolume:
$ref: '#/definitions/RecurringVolumePricingOverride'
usageFlatFee:
$ref: '#/definitions/UsageFlatFeePricingOverride'
usageOverage:
$ref: '#/definitions/UsageOveragePricingOverride'
usagePerUnit:
$ref: '#/definitions/UsagePerUnitPricingOverride'
usageTiered:
$ref: '#/definitions/UsageTieredPricingOverride'
usageTieredWithOverage:
$ref: '#/definitions/UsageTieredWithOveragePricingOverride'
usageVolume:
$ref: '#/definitions/UsageVolumePricingOverride'
type: object
productRateplanChargeId:
description: 'Internal identifier of the product rate plan charge that the
charge is based on.
'
type: string
revRecCode:
description: 'Revenue Recognition Code
'
maxLength: 70
type: string
revRecTriggerCondition:
description: "Specifies the revenue recognition trigger condition.\n\n *\
\ `Contract Effective Date` \n * `Service Activation Date`\n * `Customer\
\ Acceptance Date`\n"
enum:
- Contract Effective Date
- Service Activation Date
- Customer Acceptance Date
type: string
revenueRecognitionRuleName:
description: 'Specifies the revenue recognition rule, such as `Recognize upon
invoicing` or `Recognize daily over time`.
'
type: string
startDate:
$ref: '#/definitions/TriggerParams'
uniqueToken:
description: |
Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.
maxLength: 50
type: string
required:
- productRateplanChargeId
title: charge
type: object
ChargeTier:
properties:
endingUnit:
description: 'Limit on the number of units for which the tier is effective.
'
type: number
price:
description: 'Price or per-unit price of the tier, depending on the value
of the `priceFormat` field.
'
type: number
priceFormat:
description: 'Specifies whether the tier has a fixed price or a per-unit price.
'
enum:
- FlatFee
- PerUnit
type: string
startingUnit:
description: 'Number of units at which the tier becomes effective.
'
type: number
tier:
description: 'Index of the tier in the charge.
'
minimum: 1
type: integer
required:
- tier
- startingUnit
- price
- priceFormat
title: chargeTier
type: object
ChargeUpdateForEvergreen:
description: The JSON object containing the information for a charge update in
the 'UpdateProduct' type order action.
properties:
billing:
$ref: '#/definitions/BillingUpdate'
chargeNumber:
description: 'The number of the charge to be updated. The value of this field
is inherited from the `subscriptions` > `orderActions` > `addProduct` >
`chargeOverrides` > `chargeNumber` field.
'
type: string
customFields:
$ref: '#/definitions/RatePlanChargeObjectCustomFields'
description:
type: string
effectiveDate:
$ref: '#/definitions/TriggerParams'
pricing:
$ref: '#/definitions/PricingUpdateForEvergreen'
uniqueToken:
description: 'A unique string to represent the rate plan charge in the order.
The unique token is used to perform multiple actions against a newly added
rate plan charge. For example, if you want to add and update a product in
the same order, assign a unique token to the newly added rate plan charge
and use that token in future order actions.
'
type: string
type: object
CommonReasonsErrorResponse:
properties:
reasons:
items:
properties:
code:
description: 'The error code of response.
'
type: string
message:
description: 'The detail information of the error response.
'
type: string
type: object
type: array
type: object
CommonResponseType:
properties:
processId:
description: 'The Id of the process that handle the operation.
'
type: string
reasons:
items:
properties:
code:
description: 'The error code of response.
'
type: string
message:
description: 'The detail information of the error response
'
type: string
type: object
type: array
success:
description: 'Indicates whether the call succeeded.
'
type: boolean
type: object
ContactObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Contact 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 a Contact object.
'
title: contactFieldsCustom
type: object
CreateEntityResponseType:
properties:
displayName:
description: The display name of the entity that is shown in the Zuora UI
and APIs.
type: string
id:
description: The entity Id.
type: string
locale:
description: The locale that is used in this entity.
type: string
name:
description: The name of the entity.
type: string
parentId:
description: The Id of the parent entity.
type: string
status:
description: The status of the entity.
enum:
- Provisioned
- Unprovisioned
type: string
success:
description: Returns `true` if the request is successful.
type: boolean
tenantId:
description: The Id of the tenant that the entity belongs to.
type: string
timezone:
description: The time zone that is used in this entity.
type: string
type: object
CreateEntityType:
example:
displayName: Acme-Asia
locale: zh_CN
name: Acme-Asia
parentId: 8a808255557baba1015580e12fa5083a
timezone: Asia/Harbin
properties:
displayName:
description: |-
The display name of the entity that is shown in the Zuora UI and APIs
**Note:** If you do not specify the display name in the request, the entity name is used as the display name.
maxLength: 255
type: string
locale:
description: The locale that is used in this entity.
type: string
name:
description: "The name of the entity that is the entity identifier and is\
\ unique across all entities in a multi-entity hierarchy.\n\n**Note:** Only\
\ alphanumeric characters (letters A\u2013Z and a\u2013z, and digits 0\u2013\
9), space, period, and hyphen are allowed to be used in entity names. "
maxLength: 255
type: string
parentId:
description: "The Id of the entity under which you want to create an entity.\n\
You can get the parent entity Id by using the GET Entities call. "
type: string
timezone:
description: The time zone that is used in this entity.
type: string
required:
- name
- parentId
- locale
- timezone
type: object
CreateOrderChargeOverride:
description: 'Charge associated with a rate plan.
'
properties:
billing:
description: 'Billing information about the charge.
'
properties:
billCycleDay:
description: 'Day of the month that each billing period begins on. Only
applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.
'
maximum: 31
minimum: 0
type: integer
billCycleType:
description: |
Specifies how Zuora determines the day that each billing period begins on.
* `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.
* `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.
* `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.
* `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.
* `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.
enum:
- DefaultFromCustomer
- SpecificDayofMonth
- SubscriptionStartDay
- ChargeTriggerDay
- SpecificDayofWeek
type: string
billingPeriod:
description: |
Billing frequency of the charge. The value of this field controls the duration of each billing period.
If the value of this field is `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.
enum:
- Month
- Quarter
- Semi_Annual
- Annual
- Eighteen_Months
- Two_Years
- Three_Years
- Five_Years
- Specific_Months
- Subscription_Term
- Week
- Specific_Weeks
type: string
billingPeriodAlignment:
description: |
Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.
* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.
* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.
* `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term.
See the `billCycleType` field for information about how Zuora determines the billing day.
enum:
- AlignToCharge
- AlignToSubscriptionStart
- AlignToTermStart
type: string
billingTiming:
description: 'Specifies whether to invoice for a billing period on the
first day of the billing period (billing in advance) or the first day
of the next billing period (billing in arrears).
'
enum:
- IN_ADVANCE
- IN_ARREARS
type: string
specificBillingPeriod:
description: 'Duration of each billing period in months or weeks, depending
on the value of the `billingPeriod` field. Only applicable if the value
of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.
'
type: integer
weeklyBillCycleDay:
description: 'Day of the week that each billing period begins on. Only
applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.
'
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
type: string
type: object
chargeNumber:
description: |
Charge number of the charge. For example, C-00000307.
If you do not set this field, Zuora will generate the charge number.
maxLength: 50
type: string
customFields:
$ref: '#/definitions/RatePlanChargeObjectCustomFields'
description:
description: 'Description of the charge.
'
maxLength: 500
type: string
drawdownRate:
description: |
**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).
type: number
endDate:
$ref: '#/definitions/EndConditions'
excludeItemBillingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charge related invoice items,\
\ invoice item adjustments, credit memo items, and debit memo items from\
\ revenue accounting.\n\n**Note**: This field is only available if you have\
\ the [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)\
\ feature enabled. \n"
type: boolean
excludeItemBookingFromRevenueAccounting:
default: false
description: "The flag to exclude rate plan charges from revenue accounting.\n\
\n**Note**: This field is only available if you have the [Zuora Billing\
\ - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)\
\ feature enabled. \n"
type: boolean
isRollover:
description: |
**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.
The value is either "True" or "False". It determines whether the rollover fields are needed.
type: boolean
prepaidQuantity:
description: |
**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).
type: number
pricing:
description: 'Pricing information about the charge.
'
properties:
chargeModelData:
$ref: '#/definitions/ChargeModelDataOverride'
discount:
$ref: '#/definitions/DiscountPricingOverride'
oneTimeFlatFee:
$ref: '#/definitions/OneTimeFlatFeePricingOverride'
oneTimePerUnit:
$ref: '#/definitions/OneTimePerUnitPricingOverride'
oneTimeTiered:
$ref: '#/definitions/OneTimeTieredPricingOverride'
oneTimeVolume:
$ref: '#/definitions/OneTimeVolumePricingOverride'
recurringFlatFee:
$ref: '#/definitions/RecurringFlatFeePricingOverride'
recurringPerUnit:
$ref: '#/definitions/RecurringPerUnitPricingOverride'
recurringTiered:
$ref: '#/definitions/RecurringTieredPricingOverride'
recurringVolume:
$ref: '#/definitions/RecurringVolumePricingOverride'
usageFlatFee:
$ref: '#/definitions/UsageFlatFeePricingOverride'
usageOverage:
$ref: '#/definitions/UsageOveragePricingOverride'
usagePerUnit:
$ref: '#/definitions/UsagePerUnitPricingOverride'
usageTiered:
$ref: '#/definitions/UsageTieredPricingOverride'
usageTieredWithOverage:
$ref: '#/definitions/UsageTieredWithOveragePricingOverride'
usageVolume:
$ref: '#/definitions/UsageVolumePricingOverride'
type: object
productRatePlanChargeId:
description: 'Internal identifier of the product rate plan charge that the
charge is based on.
'
type: string
revRecCode:
description: 'Revenue Recognition Code
'
maxLength: 70
type: string
revRecTriggerCondition:
description: "Specifies the revenue recognition trigger condition.\n\n *\
\ `Contract Effective Date` \n * `Service Activation Date`\n * `Customer\
\ Acceptance Date`\n"
enum:
- Contract Effective Date
- Service Activation Date
- Customer Acceptance Date
type: string
revenueRecognitionRuleName:
description: 'Specifies the revenue recognition rule, such as `Recognize upon
invoicing` or `Recognize daily over time`.
'
type: string
rolloverApply:
description: |
**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.
This field defines the priority of rollover, which is either first or last.
enum:
- ApplyFirst
- ApplyLast
type: string
rolloverPeriods:
description: |
**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.
This field defines the number of rollover periods, it is restricted to 3.
type: number
startDate:
$ref: '#/definitions/CreateOrderTriggerParams'
uniqueToken:
description: |
Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.
maxLength: 50
type: string
validityPeriodType:
description: |
**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.
The period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
enum:
- SUBSCRIPTION_TERM
- ANNUAL
- SEMI_ANNUAL
- QUARTER
- MONTH
type: string
required:
- productRatePlanChargeId
title: charge
type: object
CreateOrderTriggerParams:
description: 'Specifies when a charge becomes active.
'
properties:
specificTriggerDate:
description: "Date in YYYY-MM-DD format. Only applicable if the value of the\
\ `triggerEvent` field is `SpecificDate`. \n\nWhile this field is applicable,\
\ if this field is not set, your `CreateSubscription` order action creates\
\ a `Pending` order and a `Pending Acceptance` subscription. If at the same\
\ time the service activation date is required and not set, a `Pending Activation`\
\ subscription is created.\n\nWhile this field is applicable, if this field\
\ is not set, the following order actions create a `Pending` order but do\
\ not impact the subscription status. **Note**: This feature is in **Limited\
\ Availability**. If you want to have access to the feature, submit a request\
\ at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n\
\ * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
format: date
type: string
triggerEvent:
description: |
Condition for the charge to become active.
If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.
enum:
- ContractEffective
- ServiceActivation
- CustomerAcceptance
- SpecificDate
type: string
title: startDate
type: object
CreatePMPayPalECPayPalNativeEC:
properties:
BAID:
description: 'ID of a PayPal billing agreement, for example, I-1TJ3GAGG82Y9.
'
type: string
email:
description: 'Email address associated with the payment method. This field
is required if you want to create a PayPal Express Checkout payment method
or a PayPal Adaptive payment method.
'
type: string
type: object
CreatePaymentMethodCardholderInfo:
description: |
Container for cardholder information. If provided, Zuora will
only use this information for this card. Otherwise, Zuora will use
the account''s existing bill-to contact information for this card.
properties:
addressLine1:
description: 'First address line, 255 characters or less.
'
type: string
addressLine2:
description: 'Second address line, 255 characters or less.
'
type: string
cardHolderName:
description: 'The card holder''s full name as it appears on the card, e.g.,
"John J Smith", 50 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
'
type: string
country:
description: 'Country, must be a valid country name or abbreviation.
'
type: string
email:
description: 'Card holder''s email address, 80 characters or less.
'
type: string
phone:
description: 'Phone number, 40 characters or less.
'
type: string
state:
description: 'State; must be a valid state name or 2-character abbreviation.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
required:
- cardHolderName
title: cardHolderInfo
type: object
CreatePaymentMethodCommon:
properties:
accountKey:
description: 'Internal ID of the customer account that will own the payment
method.
'
type: string
authGateway:
description: |
Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.
If you do not set this field, Zuora will use one of the following payment gateways instead:
* The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set.
* The default payment gateway of your Zuora tenant, if the `accountKey` field is not set.
type: string
makeDefault:
default: false
description: 'Specifies whether the payment method will be the default payment
method of the customer account that owns the payment method. Only applicable
if the `accountKey` field is set.
'
type: boolean
type: object
CreatePaymentMethodCreditCard:
properties:
cardHolderInfo:
$ref: '#/definitions/CreatePaymentMethodCardholderInfo'
cardNumber:
description: 'Credit card number.
'
type: string
cardType:
description: |
The type of the credit card.
Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).
type: string
checkDuplicated:
type: boolean
expirationMonth:
description: 'One or two digit expiration month (1-12) of the credit card.
'
type: string
expirationYear:
description: 'Four-digit expiration year of the credit card.
'
type: string
mitConsentAgreementRef:
description: 'Specifies your reference for the stored credential consent agreement
that you have established with the customer. Only applicable if you set
the `mitProfileAction` field.
'
maxLength: 128
type: string
mitConsentAgreementSrc:
description: 'Required if you set the `mitProfileAction` field. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.
'
enum:
- External
type: string
mitNetworkTransactionId:
description: 'Specifies the ID of a network transaction. Only applicable if
you set the `mitProfileAction` field to `Persist`.
'
maxLength: 128
type: string
mitProfileAction:
enum:
- Activate
- Persist
type: string
description: 'Specifies how Zuora creates and activates a stored credential profile. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.'
mitProfileAgreedOn:
description: 'The date on which the profile is agreed. The date format is
`yyyy-mm-dd`.
'
format: date
type: string
mitProfileType:
description: 'Required if you set the `mitProfileAction` field. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.
'
enum:
- Recurring
type: string
securityCode:
description: |
CVV or CVV2 security code of the credit card.
To ensure PCI compliance, this value is not stored and cannot be queried.
type: string
type: object
CreatePaymentMethodCreditCardReferenceTransaction:
properties:
secondTokenId:
description: 'The second token id of CreditCardReferenceTransaction.
'
type: string
tokenId:
description: 'The token id of payment method, required field of CreditCardReferenceTransaction
type.
'
type: string
type: object
CreatePaymentMethodPayPalAdaptive:
properties:
preapprovalKey:
description: 'The PayPal preapproval key.
'
type: string
type: object
CreateSubscriptionForEvergreen:
description: 'Information about an order action of type `CreateSubscription`.
'
properties:
billToContactId:
description: |
The ID of the bill-to contact associated with the subscription.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
clearingExistingBillToContact:
default: false
description: |
Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `paymentTerm` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingInvoiceTemplate:
default: false
description: |
Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingPaymentTerm:
default: false
description: |
Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `billToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingSequenceSet:
default: false
description: |
Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
invoiceSeparately:
description: 'Specifies whether the subscription appears on a separate invoice
when Zuora generates invoices.
'
type: boolean
invoiceTemplateId:
description: |
The ID of the invoice template associated with the subscription.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
newSubscriptionOwnerAccount:
description: |
Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature.
**Note:** The Owner Transfer feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
If you do not set this field or the `subscriptionOwnerAccountNumber` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `subscriptionOwnerAccountNumber` field.
properties:
accountNumber:
description: 'Account number. For example, A00000001.
'
maxLength: 70
type: string
autoPay:
description: 'Specifies whether future payments are automatically billed
when they are due.
'
type: boolean
batch:
description: 'Name of the billing batch that the account belongs to. For
example, Batch1.
'
type: string
billCycleDay:
description: 'Day of the month that the account prefers billing periods
to begin on. If set to 0, the bill cycle day will be set as "AutoSet".
'
maximum: 31
minimum: 0
type: integer
billToContact:
$ref: '#/definitions/BillToContact'
communicationProfileId:
description: 'Internal identifier of the communication profile that Zuora
uses when sending notifications to the account''s contacts.
'
type: string
creditCard:
$ref: '#/definitions/creditCard'
crmId:
description: 'External identifier of the account in a CRM system.
'
maxLength: 100
type: string
currency:
description: 'ISO 3-letter currency code (uppercase). For example, USD.
'
type: string
customFields:
$ref: '#/definitions/AccountObjectCustomFields'
hpmCreditCardPaymentMethodId:
description: |
The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.
If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field,
but not both.
For the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account.
type: string
invoiceDeliveryPrefsEmail:
description: "Specifies whether to turn on the invoice delivery method\
\ 'Email' for the new account. \nValues are: \n\n* `true` (default).\
\ Turn on the invoice delivery method 'Email' for the new account.\n\
* `false`. Turn off the invoice delivery method 'Email' for the new\
\ account. \n"
type: boolean
invoiceDeliveryPrefsPrint:
description: "Specifies whether to turn on the invoice delivery method\
\ 'Print' for the new account.\nValues are: \n\n* `true`. Turn on the\
\ invoice delivery method 'Print' for the new account.\n* `false` (default).\
\ Turn off the invoice delivery method 'Print' for the new account.\n"
type: boolean
invoiceTemplateId:
description: 'Internal identifier of the invoice template that Zuora uses
when generating invoices for the account.
'
type: string
name:
description: 'Account name.
'
maxLength: 70
type: string
notes:
description: 'Notes about the account. These notes are only visible to
Zuora users.
'
maxLength: 65535
type: string
parentId:
description: Identifier of the parent customer account for this Account
object. Use this field if you have customer hierarchy enabled.
type: string
paymentGateway:
description: 'The payment gateway that Zuora uses when processing electronic
payments and refunds for the account. If you do not specify this field
or if the value of this field is null, Zuora uses your default payment
gateway.
'
maxLength: 40
type: string
paymentMethod:
$ref: '#/definitions/PaymentMethod'
paymentTerm:
description: 'Name of the payment term associated with the account. For
example, "Net 30". The payment term determines the due dates of invoices.
'
type: string
soldToContact:
$ref: '#/definitions/SoldToContact'
taxInfo:
$ref: '#/definitions/TaxInfo'
required:
- name
- currency
- billCycleDay
- billToContact
type: object
notes:
description: 'Notes about the subscription. These notes are only visible to
Zuora users.
'
maxLength: 500
type: string
paymentTerm:
description: |
The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
sequenceSetId:
description: |
The ID of the sequence set associated with the subscription.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
currency:
type: string
maxLength: 3
description: |
The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used.
All subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed.
**Note**: This field is available only if you have the Multiple Currencies feature enabled.
subscribeToRatePlans:
description: 'List of rate plans associated with the subscription.
'
items:
$ref: '#/definitions/RatePlanOverrideForEvergreen'
type: array
subscriptionNumber:
description: |
Subscription number of the subscription. For example, A-S00000001.
If you do not set this field, Zuora will generate the subscription number.
maxLength: 100
type: string
subscriptionOwnerAccountNumber:
description: |
Account number of an existing account that will own the subscription. For example, A00000001.
If you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field.
maxLength: 70
type: string
terms:
description: 'Container for the terms and renewal settings of the subscription.
'
properties:
autoRenew:
description: 'Specifies whether the subscription automatically renews
at the end of the each term. Only applicable if the type of the first
term is `TERMED`.
'
type: boolean
initialTerm:
description: 'Information about the first term of the subscription.
'
properties:
period:
description: 'Duration of the first term in months, years, days, or
weeks, depending on the value of the `periodType` field. Only applicable
if the value of the `termType` field is `TERMED`.
'
type: integer
periodType:
description: 'Unit of time that the first term is measured in. Only
applicable if the value of the `termType` field is `TERMED`.
'
enum:
- Month
- Year
- Day
- Week
type: string
startDate:
description: 'Start date of the first term, in YYYY-MM-DD format.
'
format: date
type: string
termType:
description: 'Type of the first term. If the value of this field is
`TERMED`, the first term has a predefined duration based on the
value of the `period` field. If the value of this field is `EVERGREEN`,
the first term does not have a predefined duration.
'
enum:
- TERMED
- EVERGREEN
type: string
required:
- termType
type: object
renewalSetting:
description: |
Specifies the type of the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is `TERMED`.
* `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a predefined duration. The first entry in `renewalTerms` specifies the duration of the second term of the subscription, the second entry in `renewalTerms` specifies the duration of the third term of the subscription, and so on. The last entry in `renewalTerms` specifies the ultimate duration of each renewal term.
* `RENEW_TO_EVERGREEN` - The second term of the subscription does not have a predefined duration.
enum:
- RENEW_WITH_SPECIFIC_TERM
- RENEW_TO_EVERGREEN
type: string
renewalTerms:
description: 'List of renewal terms of the subscription. Only applicable
if the type of the first term is `TERMED` and the value of the `renewalSetting`
field is `RENEW_WITH_SPECIFIC_TERM`.
'
items:
$ref: '#/definitions/RenewalTerm'
type: array
required:
- initialTerm
- renewalTerms
type: object
title: createSubscription
type: object
CreditBalanceAdjustmentObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Credit Balance Adjustment 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 a Credit Balance Adjustment object.
'
title: creditBalanceAdjustmentFieldsCustom
type: object
CreditBalanceAdjustmentObjectNSFields:
description: 'Container for Credit Balance Adjustment fields provided by the [Zuora
Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
properties:
IntegrationId__NS:
description: 'ID of the corresponding object in NetSuite. Only available if
you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
IntegrationStatus__NS:
description: 'Status of the credit balance adjustment''s synchronization with
NetSuite. Only available if you have installed the [Zuora Connector for
NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
SyncDate__NS:
description: 'Date when the credit balance adjustment 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
title: creditBalanceAdjustmentFieldsNS
type: object
CustomFields:
additionalProperties:
description: '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
'
title: CustomFields
type: object
DELETEntityResponseType:
properties:
success:
description: Returns `true` if the request is successful.
type: boolean
type: object
DiscountPricingOverride:
description: 'Pricing information about a discount charge.
'
properties:
applyDiscountTo:
description: 'Specifies which type of charge the discount charge applies to.
'
enum:
- ONETIME
- RECURRING
- USAGE
- ONETIMERECURRING
- ONETIMEUSAGE
- RECURRINGUSAGE
- ONETIMERECURRINGUSAGE
type: string
discountAmount:
description: 'Only applicable if the discount charge is a fixed-amount discount.
'
type: number
discountLevel:
description: 'Application scope of the discount charge. For example, if the
value of this field is `subscription` and the value of the `applyDiscountTo`
field is `RECURRING`, the discount charge applies to all recurring charges
in the same subscription as the discount charge.
'
enum:
- rateplan
- subscription
- account
type: string
discountPercentage:
description: 'Only applicable if the discount charge is a percentage discount.
'
type: number
priceChangeOption:
description: 'Specifies how Zuora changes the price of the charge each time
the subscription renews.
'
enum:
- NoChange
- UseLatestProductCatalogPricing
type: string
title: discount
type: object
DiscountPricingUpdate:
properties:
applyDiscountTo:
description: 'Specifies which type of charge the discount charge applies to.
'
enum:
- ONETIME
- RECURRING
- USAGE
- ONETIMERECURRING
- ONETIMEUSAGE
- RECURRINGUSAGE
- ONETIMERECURRINGUSAGE
type: string
discountLevel:
description: 'Application scope of the discount charge. For example, if the
value of this field is `subscription` and the value of the `applyDiscountTo`
field is `RECURRING`, the discount charge applies to all recurring charges
in the same subscription as the discount charge.
'
enum:
- rateplan
- subscription
- account
type: string
discountPercentage:
description: 'The amount of the discount as a percentage. This field is only
used for percentage discounts.
'
type: number
priceChangeOption:
description: 'Specifies how Zuora changes the price of the charge each time
the subscription renews.
'
enum:
- NoChange
- UseLatestProductCatalogPricing
type: string
type: object
ElectronicPaymentOptions:
properties:
PaymentMethodId:
description: ''
type: string
type: object
EndConditions:
description: 'Specifies when a charge becomes inactive.
'
properties:
endDateCondition:
description: |
Condition for the charge to become inactive.
If the value of this field is `Fixed_Period`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.
If the value of this field is `Specific_End_Date`, use the `specificEndDate` field to specify the date when then charge becomes inactive.
enum:
- Subscription_End
- Fixed_Period
- Specific_End_Date
type: string
specificEndDate:
description: 'Date in YYYY-MM-DD format. Only applicable if the value of the
`endDateCondition` field is `Specific_End_Date`.
'
format: date
type: string
upToPeriods:
description: 'Duration of the charge in billing periods, days, weeks, months,
or years, depending on the value of the `upToPeriodsType` field. Only applicable
if the value of the `endDateCondition` field is `Fixed_Period`.
'
type: integer
upToPeriodsType:
description: 'Unit of time that the charge duration is measured in. Only applicable
if the value of the `endDateCondition` field is `Fixed_Period`.
'
enum:
- Billing_Periods
- Days
- Weeks
- Months
- Years
type: string
title: endDate
type: object
EventRevenueItemType:
allOf:
- properties:
accountingPeriodName:
description: 'Name of the accounting period. The open-ended accounting period
is named `Open-Ended`.
'
type: string
required:
- accountingPeriodName
type: object
- $ref: '#/definitions/RevenueEventItemObjectCustomFields'
title: revenueItems
ExecuteResult:
properties:
Errors:
description: ''
items:
$ref: '#/definitions/ActionsErrorResponse'
type: array
Id:
description: 'The ID of the object in the call. The value is the same as the
value you provide in the `ids` field for the request.
'
type: string
Success:
description: 'Returns `true` if the call was processed successfully, otherwise
`false`.
'
type: boolean
type: object
ExternalPaymentOptions:
properties:
Amount:
description: ''
format: double
type: number
EffectiveDate:
description: ''
format: date
type: string
GatewayOrderId:
description: ''
type: string
PaymentMethodId:
description: ''
type: string
ReferenceId:
description: ''
maxLength: 100
type: string
type: object
FeatureObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Feature 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 a Feature object.
'
title: featureFieldsCustom
type: object
GETAmendmentType:
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. \n"
type: boolean
baseRatePlanId:
description: 'The rate plan ID on which changes are made. Only the Update
or Remove amendment returns a base rate plan ID.
'
type: string
baseSubscriptionId:
description: 'The ID of the subscription based on which the amendment is created.
'
type: string
bookingDate:
description: 'The date when the amendment is signed. This field is to standardize
the booking date information to increase audit ability and traceability
of data between Zuora Billing and Zuora Revenue. It is mapped as the booking
date for a sale order line in Zuora Revenue.
'
format: date
type: string
code:
description: 'The amendment code.
'
type: string
contractEffectiveDate:
description: 'The date when the amendment becomes effective for billing purposes,
as `yyyy-mm-dd`.
'
format: date
type: string
currentTerm:
description: "The length of the period for the current subscription term.\
\ \n"
format: int64
type: integer
currentTermPeriodType:
description: |
The period type for the current subscription term.
Possible values are:
- Month
- Year
- Day
- Week
type: string
customerAcceptanceDate:
description: 'The date when the customer accepts the amendment changes to
the subscription, as `yyyy-mm-dd`.
'
format: date
type: string
description:
description: 'Description of the amendment.
'
type: string
destinationAccountId:
description: 'The ID of the account that the subscription is being transferred
to.
'
type: string
destinationInvoiceOwnerId:
description: 'The ID of the invoice that the subscription is being transferred
to.
'
type: string
effectiveDate:
description: "The date when the amendment changes take effective. \n"
format: date
type: string
effectivePolicy:
description: |2
Effective Policy for the subscription. Possible values are:
- EffectiveImmediately
- EffectiveEndOfBillingPeriod
- SpecificDate
The value depends on the following conditions:
* If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.
* If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.
* Otherwise, the effective policy is `SpecificDate` by default.
**Note:** This feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
type: string
id:
description: 'The amendment ID.
'
type: string
name:
description: 'The name of the amendment.
'
type: string
newRatePlanId:
description: 'The ID of the rate plan charge on which amendment is made. Only
the Add or Update amendment returns a new rate plan ID.
'
type: string
newSubscriptionId:
description: 'The ID of the subscription that the amendment changes.
'
type: string
renewalSetting:
description: |
Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.
Possible values are:
- RENEW_WITH_SPECIFIC_TERM
- RENEW_TO_EVERGREEN
type: string
renewalTerm:
description: 'The term of renewal for the amended subscription.
'
format: int64
type: integer
renewalTermPeriodType:
description: |
The period type for the subscription renewal term.
Possible values are:
- Month
- Year
- Day
- Week
type: string
resumeDate:
description: |
The date when the subscription resumption takes effect, as `yyyy-mm-dd`.
**Note:** This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
format: date
type: string
serviceActivationDate:
description: 'The date when service is activated, as `yyyy-mm-dd`.
'
format: date
type: string
specificUpdateDate:
description: "The date when the Update Product amendment takes effect. \n\
Only for the Update Product amendments if there is already a future-dated\
\ Update Product amendment on\nthe subscription.\n"
format: date
type: string
status:
description: "The status of the amendment.\nPossible values are:\n\n- Draft\
\ \n- Pending Activation\n- Pending Acceptance\n- Completed\n"
type: string
subType:
description: "Sub type for the subscription. \n\nPossible values are:\n\n\
- Upgrade\n\n- Downgrade\n\n- Crossgrade\n\n- PlanChanged\n\nThis field\
\ shows the sub type you choose for your change plan amendment.\n\nHowever,\
\ if you do not set this field, the field will be automatically generated\
\ by the system according to the following rules:\n\nWhen the old and new\
\ rate plans are within the same Grading catalog group:\n* If the grade\
\ of new plan is greater than that of the old plan, this is an \"Upgrade\"\
.\n* If the grade of new plan is less than that of the old plan, this is\
\ a \"Downgrade\".\n* If the grade of new plan equals that of the old plan,\
\ this is a \"Crossgrade\".\n\nWhen the old and new rate plans are not in\
\ the same Grading catalog group, or either has no group, this is \"PlanChanged\"\
.\n\n**Note:** This feature is in the **Early Adopter** phase. We are actively\
\ soliciting feedback from a small set of early adopters before releasing\
\ it as generally available. If you want to join this early adopter program,\
\ submit a request at [Zuora Global Support](http://support.zuora.com/).\n"
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
suspendDate:
description: |
The date when the subscription suspension takes effect, as `yyyy-mm-dd`.
**Note:** This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
format: date
type: string
termStartDate:
description: 'The date when the new terms and conditions take effect.
'
format: date
type: string
termType:
description: 'Indicates if the subscription is `TERMED` or `EVERGREEN`.
'
type: string
type:
description: |
Type of the amendment.
Possible values are:
- Cancellation
- NewProduct
- OwnerTransfer
- RemoveProduct
- Renewal
- UpdateProduct
- TermsAndConditions
- ChangePlan - Note that this feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
type: string
type: object
GETChargeRSDetailType:
properties:
accountId:
description: 'An account ID.
'
type: string
amount:
description: 'The revenue schedule amount, which is the sum of all revenue
items. This field cannot be null and must be formatted based on the currency,
such as *JPY 30* or USD *30.15*. Test out the currency to ensure you are
using the proper formatting otherwise, the response will fail and this error
message is returned: *"Allocation amount with wrong decimal places."*
'
format: decimal
type: string
currency:
description: "The type of currency used. \n"
type: string
notes:
description: 'Additional information about this record.
'
type: string
number:
description: 'The charge revenue summary number.
'
type: string
recognitionRuleName:
description: 'The name of the recognition rule.
'
type: string
recognizedRevenue:
description: 'The revenue that was distributed in a closed accounting period.
'
format: decimal
type: string
revenueItems:
description: 'Revenue items are listed in ascending order by the accounting
period start date.
'
items:
$ref: '#/definitions/GETRevenueItemTypeResponse'
type: array
subscriptionChargeId:
description: 'The original subscription charge ID.
'
type: string
subscriptionId:
description: 'The original subscription ID.
'
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
undistributedUnrecognizedRevenue:
description: 'Revenue in the open-ended accounting period.
'
format: decimal
type: string
unrecognizedRevenue:
description: 'Revenue distributed in all open accounting periods, which includes
the open-ended accounting period.
'
format: decimal
type: string
type: object
GETDocumentPropertiesResponseType:
properties:
customFileName:
description: 'The custom file name used by Word or PDF files generated for
the billing document.
'
type: string
documentId:
description: 'The unique ID of a billing document.
'
type: string
documentType:
description: "The type of the billing document. \n"
enum:
- Invoice
- CreditMemo
- DebitMemo
type: string
id:
description: 'The unique ID of a document property.
'
type: string
success:
description: 'Indicates whether the call succeeded.
'
type: boolean
type: object
GETEntitiesResponseType:
properties:
entities:
description: Container for one or more entities in a multi-entity hierarchy.
items:
$ref: '#/definitions/GETEntitiesType'
type: array
success:
description: Returns `true` if the request is successful.
type: boolean
type: object
GETEntitiesResponseTypeWithId:
properties:
displayName:
description: The display name of the entity that is shown in the Zuora UI
and APIs.
type: string
id:
description: The entity Id.
type: string
locale:
description: The locale that is used in this entity.
type: string
name:
description: The name of the entity.
type: string
parentId:
description: The Id of the parent entity.
type: string
status:
description: The status of the entity.
enum:
- Provisioned
- Unprovisioned
type: string
success:
description: Returns `true` if the request is successful.
type: boolean
tenantId:
description: The Id of the tenant that the entity belongs to.
type: string
timezone:
description: The time zone that is used in this entity.
type: string
type: object
GETEntitiesType:
properties:
displayName:
description: 'The display name of the entity that is shown in the Zuora UI
and APIs.
'
type: string
id:
description: 'The entity Id.
'
type: string
locale:
description: 'The locale that is used in this entity.
'
type: string
name:
description: 'The name of the entity.
'
type: string
parentId:
description: 'The Id of the parent entity.
'
type: string
status:
description: 'The status of the entity.
'
enum:
- Provisioned
- Unprovisioned
type: string
tenantId:
description: 'The Id of the tenant that the entity belongs to.
'
type: string
timezone:
description: 'The time zone that is used in this entity.
'
type: string
title: entities
type: object
GETEntitiesUserAccessibleResponseType:
properties:
entities:
description: 'Container for one or more entities in a multi-entity hierarchy.
'
items:
$ref: '#/definitions/GETEntitiesType'
type: array
success:
description: 'Returns `true` if the request is successful.
'
type: boolean
type: object
GETEntityConnectionsArrayItemsType:
properties:
id:
description: 'The ID of the connection.
'
type: string
sourceEntityId:
description: 'The ID of the source entity in the connection.
'
type: string
status:
description: "Status of the connection. \n\nPossible values:\n - `Connected`\n\
\ - `Pending`\n - `Disconnected`\n"
type: string
targetEntityId:
description: 'The ID of the target entity in the connection.
'
type: string
title: entityConnections
type: object
GETEntityConnectionsResponseType:
properties:
entityConnections:
description: 'Container for one or more connections that are related to the
entity.
'
items:
$ref: '#/definitions/GETEntityConnectionsArrayItemsType'
type: array
nextPage:
description: 'URL to retrieve the next page of the response if it exists;
otherwise absent.
'
format: URL
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
GETInvoiceFileWrapper:
properties:
invoices:
description: 'Contains information about one or more invoices. The array contains
a maximum of 300 invoices.
'
items:
$ref: '#/definitions/GETInvoiceType'
type: array
nextPage:
description: 'URL to retrieve the next page of the response if it exists;
otherwise absent.
'
format: URL
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
GETInvoiceType:
allOf:
- properties:
accountId:
description: 'Customer account ID.
'
type: string
accountName:
description: 'Customer account name.
'
type: string
accountNumber:
description: 'Customer account number.
'
type: string
amount:
description: 'Amount of the invoice before adjustments, discounts, and similar
items.
'
format: decimal
type: string
balance:
description: 'Balance remaining due on the invoice (after adjustments, discounts,
etc.)
'
format: decimal
type: string
body:
description: 'The REST URL of the invoice PDF file.
'
type: string
createdBy:
description: 'User ID of the person who created the invoice. If a bill run
generated the invoice, then this is the user ID of person who created
the bill run.
'
type: string
creditBalanceAdjustmentAmount:
description: ''
format: decimal
type: string
dueDate:
description: 'Payment due date as _yyyy-mm-dd_.
'
format: date
type: string
id:
description: 'Invoice ID.
'
type: string
invoiceDate:
description: 'Invoice date as _yyyy-mm-dd_
'
format: date
type: string
invoiceFiles:
description: "URL to retrieve information about all files of a specific\
\ invoice if any file exists; otherwise absent. For example, `https://rest.zuora.com/v1/invoices/2c92c095511f5b4401512682dcfd7987/files`.\
\ If you want to view the invoice file details, call [Get invoice files](https://developer.zuora.com/api-references/api/operation/GET_InvoiceFiles)\
\ with the returned URL.\n\nIf your tenant was created before Zuora Release\
\ 228 (R228), July 2018, the value of this field is an array of invoice\
\ file details. For more information about the array, see the response\
\ body of [Get invoice files](https://developer.zuora.com/api-references/api/operation/GET_InvoiceFiles).\
\ \n\nZuora recommends that you use the latest behavior to retrieve invoice\
\ information. If you wish to have access to the feature, submit a request\
\ at [Zuora Global Support](http://support.zuora.com/) asking for invoice\
\ item and file references to be enabled in the REST API.\n"
format: URL
type: string
invoiceItems:
description: "URL to retrieve information about all items of a specific\
\ invoice. For example, `https://rest.zuora.com/v1/invoices/2c92c095511f5b4401512682dcfd7987/items`.\
\ If you want to view the invoice item details, call [Get invoice items](https://developer.zuora.com/api-references/api/operation/GET_InvoiceItems)\
\ with the returned URL.\n\nIf your tenant was created before Zuora Release\
\ 228 (R228), July 2018, the value of this field is an array of invoice\
\ item details. For more information about the array, see the response\
\ body of [Get invoice items](https://developer.zuora.com/api-references/api/operation/GET_InvoiceItems).\
\ \n\nZuora recommends that you use the latest behavior to retrieve invoice\
\ information. If you wish to have access to the feature, submit a request\
\ at [Zuora Global Support](http://support.zuora.com/) asking for invoice\
\ item and file references to be enabled in the REST API. \n"
format: URL
type: string
invoiceNumber:
description: 'Unique invoice ID, returned as a string.
'
type: string
invoiceTargetDate:
description: 'Date through which charges on this invoice are calculated,
as _yyyy-mm-dd_.
'
format: date
type: string
reversed:
description: 'Whether the invoice is reversed.
'
type: boolean
status:
description: 'Status of the invoice in the system - not the payment status,
but the status of the invoice itself. Possible values are: `Posted`, `Draft`,
`Canceled`, `Error`.
'
type: string
type: object
- $ref: '#/definitions/InvoiceObjectNSFields'
- $ref: '#/definitions/InvoiceObjectCustomFields'
title: invoices
GETPaidInvoicesType:
properties:
appliedPaymentAmount:
description: 'Amount of the payment applied to this invoice.
'
format: decimal
type: string
invoiceId:
description: 'Invoice ID.
'
type: string
invoiceNumber:
description: 'Invoice number.
'
type: string
title: paidInvoices
type: object
GETPaymentGatewayTransactionLogElementResponse:
properties:
createTime:
description: 'The timestamp of the logs created in ISO-8601 format.
'
type: string
createdBy:
description: 'The ID of the user who created the transaction.
'
type: string
currency:
description: 'The type of currenty, in which the transaction was made.
'
type: string
gatewayId:
description: 'The ID of the gateway, through which the transaction was processed.
'
type: string
gatewayName:
description: 'The name of the gateway, through which the transaction was processed.
'
type: string
gatewayType:
description: 'The type of the valid gateway, through which the transactioin
was processed.
'
type: string
gatewayVersion:
description: 'The version of the gateway, through which the transaction was
processed.
'
type: string
id:
description: 'The unique ID of the transaction log.
'
type: string
operationId:
description: 'The ID of the transaction operation.
'
type: string
operationType:
description: 'The type of transaction operation, such as `Payment`, `Refund`,
`Validation`.
'
type: string
paymentMethodType:
description: 'The type of the payment method used for the transaction, such
as `Credit Card`, `ACH`, etc.
'
type: string
receiveTime:
description: 'The time when Zuora received the response.
'
type: string
request:
description: 'The request parameters when sending the request.
'
type: string
response:
description: 'The response body of the received response.
'
type: string
responseCode:
description: 'The code associated with the response. The value can be `Success`,
`Failure`, or `Error`.
'
type: string
sendTime:
description: 'The time when Zuora sent the request.
'
type: string
tenantId:
description: 'The tenant ID of the user requesting the logs.
'
type: string
updatedBy:
description: 'The ID of the user who last updated the transaction.
'
type: string
updatedTime:
description: 'The timestamp of logs updated in ISO-8601 format.
'
type: string
zReferenceId:
description: 'The payment or refund Id.
'
type: string
title: payment transaction log record
type: object
GETPaymentGatewayTransactionLogResponse:
properties:
data:
description: 'Container for the payment gateway transaction log records.
'
items:
$ref: '#/definitions/GETPaymentGatewayTransactionLogElementResponse'
type: array
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
GETPaymentMethodType:
properties:
cardHolderInfo:
description: 'Container for the name and billing address for the card holder.
'
properties:
addressLine1:
description: 'First address line, 255 characters or less.
'
type: string
addressLine2:
description: 'Second address line, 255 characters or less.
'
type: string
cardHolderName:
description: 'The full name as it appears on the card, e.g., "John J Smith",
50 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
'
type: string
country:
description: "Country, must be a valid country name or abbreviation.\n\
When creating a payment method through a translated UI or Payment Page,\
\ a country name in a translated language might be selected. Regardless\
\ of the country texts selected when creating the payment method, only\
\ the country name listed in\_[Country Names and Their ISO Standard\
\ 2- and 3-Digit Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/A_Country_Names_and_Their_ISO_Codes)\_\
returns in this field. Internationalization is not supported for the\
\ API field value.\n"
type: string
email:
description: 'Card holder''s email address, 80 characters or less.
'
type: string
phone:
description: 'Phone number, 40 characters or less.
'
type: string
state:
description: 'State, must be a valid state name or 2-character abbreviation.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
type: object
cardNumber:
description: 'Credit or debit card number, 16 characters or less, masked for
security purposes.
'
type: string
cardType:
description: "The type of the credit card.\n \nPossible values include\
\ `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`.\
\ For more information about credit card types supported by different payment\
\ gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).\n"
type: string
defaultPaymentMethod:
description: 'Contains true if this is the default payment method for this
customer, otherwise false.
'
type: boolean
expirationMonth:
description: 'One or two digit(s) expiration month (1-12).
'
type: integer
expirationYear:
description: 'Four-digit expiration year.
'
type: integer
id:
description: 'Unique ID generated by Zuora when this payment method was created.
'
type: string
title: creditCards
type: object
GETPaymentMethodsType:
properties:
creditCards:
description: 'Container for one or more credit or debit card records:
'
items:
$ref: '#/definitions/GETPaymentMethodType'
type: array
nextPage:
description: 'URL to retrieve the next page of the response if it exists;
otherwise absent.
'
format: URL
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
GETPaymentType:
allOf:
- properties:
accountID:
description: 'Customer account ID.
'
type: string
accountName:
description: 'Customer account name.
'
type: string
accountNumber:
description: 'Customer account number.
'
type: string
amount:
description: 'Payment amount.
'
format: decimal
type: string
effectiveDate:
description: 'Effective payment date as _yyyy-mm-dd_.
'
format: date
type: string
gatewayTransactionNumber:
description: 'Transaction ID from payment gateway.
'
type: string
id:
description: 'PaymentID.
'
type: string
paidInvoices:
description: 'Information about one or more invoices to which this payment
was applied:
'
items:
$ref: '#/definitions/GETPaidInvoicesType'
type: array
paymentMethodID:
description: 'Payment method.
'
type: string
paymentNumber:
description: 'Unique payment number.
'
type: string
status:
description: 'Possible values are: `Draft`, `Processing`, `Processed`, `Error`,
`Voided`, `Canceled`, `Posted.
'
type: string
type:
description: 'Possible values are: `External`, `Electronic`.
'
type: string
type: object
- $ref: '#/definitions/PaymentObjectNSFields'
- $ref: '#/definitions/PaymentObjectCustomFields'
title: payments
GETPaymentsType:
properties:
nextPage:
description: 'URL to retrieve the next page of the response if it exists;
otherwise absent.
'
format: URL
type: string
payments:
description: 'Information about one or more payments:
'
items:
$ref: '#/definitions/GETPaymentType'
type: array
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
GETRSDetailForProductChargeType:
allOf:
- properties:
accountId:
description: 'The ID of a customer account.
'
type: string
amount:
description: "The revenue schedule amount, which is the sum of all revenue\
\ items. \n\nThis field cannot be null and must be formatted based on\
\ the currency, such as `JPY 30` or `USD 30.15`. Test out the currency\
\ to ensure you are using the proper formatting; otherwise, the response\
\ will fail and this error message is returned: `Allocation amount with\
\ wrong decimal places`.\n"
type: string
createdOn:
description: 'The date and time when the record was created, in `yyyy-mm-dd
hh:mm:ss` format.
'
format: date-time
type: string
currency:
description: 'The type of currency used.
'
type: string
linkedTransactionId:
description: 'The linked transaction ID for billing transactions. This field
is used for all rules except for the custom unlimited or manual recognition
rule models. If using the custom unlimited rule model, then the field
value must be null. If the field is not null, then the referenceId field
must be null.
'
type: string
linkedTransactionNumber:
description: 'The number for the linked invoice item, invoice item adjustment,
or debit memo item transaction. This field is used for all rules except
for the custom unlimited or manual recognition rule models. If using the
custom unlimited or manual recognition rule models, then the field value
is null.
'
type: string
linkedTransactionType:
description: 'The type of linked transaction for billing transactions, which
can be invoice item, invoice item adjustment, or debit memo item. This
field is used for all rules except for the custom unlimited or manual
recognition rule models.
'
type: string
notes:
description: 'Additional information about this record.
'
type: string
number:
description: 'The revenue schedule number. The revenue schedule number is
always prefixed with "RS", for example, "RS-00000001".
'
type: string
productChargeId:
description: 'The ID of a product rate plan charge.
'
type: string
recognitionRuleName:
description: 'The name of the recognition rule.
'
type: string
recognizedRevenue:
description: 'The revenue that was distributed in a closed accounting period.
'
type: string
referenceId:
description: 'The reference ID is used only in the custom unlimited rule
to create a revenue schedule. In this scenario, the revenue schedule is
not linked to a credit memo item.
'
type: string
revenueItems:
description: 'Revenue items are listed in ascending order by the accounting
period start date.
'
items:
$ref: '#/definitions/GETRsRevenueItemType'
type: array
revenueScheduleDate:
description: |
The effective date of the revenue schedule. For example, the revenue schedule date for bookings-based revenue recognition is typically set to the order date or contract date.
The date cannot be in a closed accounting period. The date must be in `yyyy-mm-dd` format.
format: date
type: string
undistributedUnrecognizedRevenue:
description: 'The revenue in the open-ended accounting period.
'
type: string
unrecognizedRevenue:
description: 'The revenue distributed in all open accounting periods, which
includes the open-ended accounting period.
'
type: string
updatedOn:
description: 'The date and time when the revenue automation start date was
set, in `yyyy-mm-dd hh:mm:ss` format.
'
format: date-time
type: string
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
GETRSDetailType:
allOf:
- properties:
accountId:
description: 'An account ID.
'
type: string
amount:
description: 'The revenue schedule amount, which is the sum of all revenue
items. This field cannot be null and must be formatted based on the currency,
such as `JPY 30` or `USD 30.15`. Test out the currency to ensure you are
using the proper formatting otherwise, the response will fail and this
error message is returned: `Allocation amount with wrong decimal places.`
'
format: decimal
type: string
createdOn:
description: 'The date and time when the record was created, in `yyyy-mm-dd
hh:mm:ss` format.
'
format: date-time
type: string
currency:
description: 'The type of currency used.
'
type: string
linkedTransactionId:
description: 'The linked transaction ID for billing transactions. This field
is used for all rules except for the custom unlimited or manual recognition
rule models. If using the custom unlimited rule model, then the field
value must be null. If the field is not null, then the referenceId field
must be null.
'
type: string
linkedTransactionNumber:
description: 'The number for the linked invoice item or invoice item adjustment
transaction. This field is used for all rules except for the custom unlimited
or manual recognition rule models. If using the custom unlimited or manual
recognition rule models, then the field value is null.
'
type: string
linkedTransactionType:
description: 'The type of linked transaction for billing transactions, which
can be invoice item or invoice item adjustment. This field is used for
all rules except for the custom unlimited or manual recognition rule models.
'
type: string
notes:
description: 'Additional information about this record.
'
type: string
number:
description: 'Revenue schedule number. The revenue schedule number is always
prefixed with "RS", for example, "RS-00000001".
'
type: string
recognitionRuleName:
description: 'The name of the recognition rule.
'
type: string
recognizedRevenue:
description: 'The revenue that was distributed in a closed accounting period.
'
format: decimal
type: string
referenceId:
description: 'Reference ID is used only in the custom unlimited rule to
create a revenue schedule. In this scenario, the revenue schedule is not
linked to an invoice item or invoice item adjustment.
'
type: string
revenueItems:
description: 'Revenue items are listed in ascending order by the accounting
period start date.
'
items:
$ref: '#/definitions/GETRsRevenueItemType'
type: array
revenueScheduleDate:
description: |
The effective date of the revenue schedule. For example, the revenue schedule date for bookings-based revenue recognition is typically set to the order date or contract date.
The date cannot be in a closed accounting period. The date must be in `yyyy-mm-dd` format.
format: date
type: string
subscriptionChargeId:
description: 'The original subscription charge ID.
'
type: string
subscriptionId:
description: 'The original subscription ID.
'
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
undistributedUnrecognizedRevenue:
description: 'Revenue in the open-ended accounting period.
'
format: decimal
type: string
unrecognizedRevenue:
description: 'Revenue distributed in all open accounting periods, which
includes the open-ended accounting period.
'
format: decimal
type: string
updatedOn:
description: 'The date and time when the revenue automation start date was
set, in `yyyy-mm-dd hh:mm:ss` formst.
'
format: date-time
type: string
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
GETRSDetailWithoutSuccessType:
allOf:
- properties:
accountId:
description: 'An account ID.
'
type: string
amount:
description: 'The revenue schedule amount, which is the sum of all revenue
items. This field cannot be null and must be formatted based on the currency,
such as `JPY 30` or `USD 30.15`. Test out the currency to ensure you are
using the proper formatting otherwise, the response will fail and this
error message is returned: `Allocation amount with wrong decimal places.`
'
format: decimal
type: string
createdOn:
description: 'The date and time when the record was created, in `yyyy-mm-dd
hh:mm:ss` format.
'
format: date-time
type: string
currency:
description: 'The type of currency used.
'
type: string
linkedTransactionId:
description: 'The linked transaction ID for billing transactions. This field
is used for all rules except for the custom unlimited or manual recognition
rule models. If using the custom unlimited rule model, then the field
value must be null. If the field is not null, then the referenceId field
must be null.
'
type: string
linkedTransactionNumber:
description: 'The number for the linked invoice item or invoice item adjustment
transaction. This field is used for all rules except for the custom unlimited
or manual recognition rule models. If using the custom unlimited or manual
recognition rule models, then the field value is null.
'
type: string
linkedTransactionType:
description: 'The type of linked transaction for billing transactions, which
can be invoice item or invoice item adjustment. This field is used for
all rules except for the custom unlimited or manual recognition rule models.
'
type: string
notes:
description: 'Additional information about this record.
'
type: string
number:
description: 'Revenue schedule number. The revenue schedule number is always
prefixed with "RS", for example, "RS-00000001".
'
type: string
recognitionRuleName:
description: 'The name of the recognition rule.
'
type: string
recognizedRevenue:
description: 'The revenue that was distributed in a closed accounting period.
'
format: decimal
type: string
referenceId:
description: 'Reference ID is used only in the custom unlimited rule to
create a revenue schedule. In this scenario, the revenue schedule is not
linked to an invoice item or invoice item adjustment.
'
type: string
revenueItems:
description: 'Revenue items are listed in ascending order by the accounting
period start date.
'
items:
$ref: '#/definitions/GETRsRevenueItemType'
type: array
revenueScheduleDate:
description: |
The effective date of the revenue schedule. For example, the revenue schedule date for bookings-based revenue recognition is typically set to the order date or contract date.
The date cannot be in a closed accounting period. The date must be in the `yyyy-mm-dd` format.
format: date
type: string
subscriptionChargeId:
description: 'The original subscription charge ID.
'
type: string
subscriptionId:
description: 'The original subscription ID.
'
type: string
undistributedUnrecognizedRevenue:
description: 'Revenue in the open-ended accounting period.
'
format: decimal
type: string
unrecognizedRevenue:
description: 'Revenue distributed in all open accounting periods, which
includes the open-ended accounting period.
'
format: decimal
type: string
updatedOn:
description: 'The date when the revenue automation start date was set, in
`yyyy-mm-dd hh:mm:ss` format.
'
format: date-time
type: string
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
title: revenueSchedules
GETRSDetailsByChargeType:
properties:
nextPage:
description: 'URL to retrieve the next page of the response if it exists;
otherwise absent.
'
format: URL
type: string
revenueSchedules:
description: |
Represents how revenue will be recognized over time.
This contains the details of a revenue schedule. If you do not specify the `pageSize` variable, the default number of revenue schedules returned per invocation is 8, and if there are more than 8 revenue schedules to be returned, the `nextPage` field will provide a hyperlink to view the next page(s) of revenue events. The order of revenue schedules is descending by the `updatedOn` field.
items:
$ref: '#/definitions/GETRSDetailWithoutSuccessType'
type: array
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
GETRSDetailsByProductChargeType:
example: ''
properties:
nextPage:
description: 'URL to retrieve the next page of the response if it exists;
otherwise absent.
'
format: URL
type: string
revenueSchedules:
description: 'How revenue will be recognized over time.
'
items:
$ref: '#/definitions/GETRSDetailForProductChargeType'
type: array
success:
description: Returns `true` if the request was processed successfully.
type: boolean
type: object
GETRevenueEventDetailType:
allOf:
- properties:
accountId:
description: 'An account ID.
'
type: string
createdOn:
description: 'The date when the record was created in YYYY-MM-DD HH:MM:SS
format.
'
format: date-time
type: string
currency:
description: 'The type of currency used.
'
type: string
eventType:
description: |
Label of the revenue event type. Revenue event type labels can be duplicated. You can configure your revenue event type labels by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Note that `Credit Memo Posted` and `Debit Memo Posted` are only available if you enable the Invoice Settlement feature.
enum:
- Invoice Posted
- Invoice Item Adjustment Created
- Invoice Canceled
- Invoice Item Adjustment Canceled
- Revenue Distributed
- Credit Memo Posted
- Debit Memo Posted
type: string
notes:
description: 'Additional information about this record.
'
type: string
number:
description: 'The revenue event number created when a revenue event occurs.
'
type: string
recognitionEnd:
description: "The end date of a recognition period in YYYY-MM-DD format.\
\ \n\nThe maximum difference of the recognitionStart and recognitionEnd\
\ date fields is equal to 250 multiplied by the length of an accounting\
\ period.\n"
format: date
type: string
recognitionStart:
description: 'The start date of a recognition period in YYYY-MM-DD format.
'
format: date
type: string
revenueItems:
description: 'Revenue items are listed in ascending order by the accounting
period start date.
'
items:
$ref: '#/definitions/GETRevenueItemType'
type: array
subscriptionChargeId:
description: 'The original subscription charge ID.
'
type: string
subscriptionId:
description: 'The original subscription ID.
'
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
- $ref: '#/definitions/RevenueEventObjectCustomFields'
GETRevenueEventDetailWithoutSuccessType:
allOf:
- properties:
accountId:
description: 'An account ID.
'
type: string
createdOn:
description: 'The date when the record was created in YYYY-MM-DD HH:MM:SS
format.
'
format: date-time
type: string
currency:
description: The type of currency used.
type: string
eventType:
description: |
Label of the revenue event type. Revenue event type labels can be duplicated. You can configure your revenue event type labels by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Note that `Credit Memo Posted` and `Debit Memo Posted` are only available if you enable the Invoice Settlement feature.
enum:
- Invoice Posted
- Invoice Item Adjustment Created
- Invoice Canceled
- Invoice Item Adjustment Canceled
- Revenue Distributed
- Credit Memo Posted
- Debit Memo Posted
type: string
notes:
description: 'Additional information about this record.
'
type: string
number:
description: 'The revenue event number created when a revenue event occurs.
'
type: string
recognitionEnd:
description: "The end date of a recognition period in YYYY-MM-DD format.\
\ \n\nThe maximum difference of the recognitionStart and recognitionEnd\
\ date fields is equal to 250 multiplied by the length of an accounting\
\ period.\n"
format: date
type: string
recognitionStart:
description: 'The start date of a recognition period in YYYY-MM-DD format.
'
format: date
type: string
revenueItems:
description: 'Revenue items are listed in ascending order by the accounting
period start date.
'
items:
$ref: '#/definitions/GETRevenueItemType'
type: array
subscriptionChargeId:
description: 'The original subscription charge ID.
'
type: string
subscriptionId:
description: 'The original subscription ID.
'
type: string
type: object
- $ref: '#/definitions/RevenueEventObjectCustomFields'
title: revenueEventDetails
GETRevenueEventDetailsType:
properties:
nextPage:
description: 'URL to retrieve the next page of the response if it exists;
otherwise absent.
'
format: URL
type: string
revenueEventDetails:
description: 'Represents a change to a revenue schedule, such as posting an
invoice or distributing revenue.
'
items:
$ref: '#/definitions/GETRevenueEventDetailWithoutSuccessType'
type: array
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
GETRevenueItemType:
allOf:
- properties:
accountingPeriodEndDate:
description: "The accounting period end date. The accounting period end\
\ date of the open-ended accounting period is null. \n"
format: date
type: string
accountingPeriodName:
description: "Name of the accounting period. The open-ended accounting period\
\ is named `Open-Ended`. \n"
type: string
accountingPeriodStartDate:
description: 'The accounting period start date.
'
format: date
type: string
amount:
description: 'The revenue schedule amount, which is the sum of all revenue
items. This field cannot be null and must be formatted based on the currency,
such as *JPY 30* or *USD 30.15*. Test out the currency to ensure you are
using the proper formatting otherwise, the response will fail and this
error message is returned: `Allocation amount with wrong decimal places.`
'
format: decimal
type: string
currency:
description: "The type of currency used. \n"
type: string
isAccountingPeriodClosed:
description: "Indicates if the accounting period is closed or open. \n"
type: boolean
type: object
- $ref: '#/definitions/RevenueEventItemObjectCustomFields'
title: revenueItems
GETRevenueItemTypeResponse:
properties:
accountingPeriodEndDate:
description: 'The accounting period end date. The accounting period end date
of the open-ended accounting period is null.
'
format: date
type: string
accountingPeriodName:
description: "Name of the accounting period. The open-ended accounting period\
\ is named Open-Ended. \n"
type: string
accountingPeriodStartDate:
description: 'The accounting period start date.
'
format: date
type: string
amount:
description: 'The amount of the revenue item.
'
format: decimal
type: string
currency:
description: "The type of currency used. \n"
type: string
isAccountingPeriodClosed:
description: "Indicates if the accounting period is closed or open. \n"
type: boolean
title: revenueItems
type: object
GETRevenueItemsType:
properties:
nextPage:
description: 'URL to retrieve the next page of the response if it exists;
otherwise absent.
'
format: URL
type: string
revenueItems:
description: 'Revenue items are listed in ascending order by the accounting
period start date.
'
items:
$ref: '#/definitions/GETRevenueItemType'
type: array
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
GETRevenueRecognitionRuleAssociationType:
properties:
revenueRecognitionRuleName:
description: |
The name of the revenue recognition rule governing the revenue
schedule.
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
GETRevenueStartDateSettingType:
properties:
startDate:
description: 'The date on which revenue automation starts. This is the first
day of an accounting period.
'
format: date
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
updatedBy:
description: 'The user who made the change.
'
type: string
updatedOn:
description: 'The date when the revenue automation start date was set.
'
format: date-time
type: string
type: object
GETRsRevenueItemType:
allOf:
- properties:
accountingPeriodEndDate:
description: 'The accounting period end date. The accounting period end
date of the open-ended accounting period is null.
'
format: date
type: string
accountingPeriodName:
description: 'The name of the accounting period. The open-ended accounting
period is named `Open-Ended`.
'
type: string
accountingPeriodStartDate:
description: 'The accounting period start date.
'
format: date
type: string
amount:
description: 'The amount of the revenue item.
'
format: decimal
type: string
currency:
description: 'The type of currency used.
'
type: string
deferredRevenueAccountingCode:
description: 'The accounting code for deferred revenue, such as Monthly
Recurring Liability. Required only when `overrideChargeAccountingCodes`
is `true`. Otherwise, this value is ignored.
'
type: string
deferredRevenueAccountingCodeType:
description: 'The type of the deferred revenue accounting code, such as
Deferred Revenue. Required only when `overrideChargeAccountingCodes` is
`true`. Otherwise, this value is ignored.
'
type: string
isAccountingPeriodClosed:
description: 'Indicates if the accounting period is closed or open.
'
type: boolean
recognizedRevenueAccountingCode:
description: 'The accounting code for recognized revenue, such as Monthly
Recurring Charges or Overage Charges. Required only when `overrideChargeAccountingCodes`
is `true`. Otherwise, the value is ignored.
'
type: string
recognizedRevenueAccountingCodeType:
description: 'The type of the recognized revenue accounting code, such as
Sales Revenue or Sales Discount. Required only when `overrideChargeAccountingCodes`
is `true`. Otherwise, this value is ignored.
'
type: string
type: object
- $ref: '#/definitions/RevenueScheduleItemObjectCustomFields'
title: revenueItems
GETRsRevenueItemsType:
properties:
nextPage:
description: 'URL to retrieve the next page of the response if it exists;
otherwise absent.
'
format: URL
type: string
revenueItems:
description: 'Revenue items are listed in ascending order by the accounting
period start date.
'
items:
$ref: '#/definitions/GETRsRevenueItemType'
type: array
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
GatewayOption:
properties:
name:
description: 'The name of a gateway-specific parameter. This field is optional,
but you must pass value for this field when using the `GatewayOptionData`
field. Otherwise, the additional payment gateway parameter will not be mapped.
'
type: string
value:
description: 'The value of the gateway-specific parameter. This field is optional,
but you must pass value for this field when using the `GatewayOptionData`
field. Otherwise, the additional payment gateway parameter will not be mapped.
'
type: string
type: object
GetOrderResponseForEvergreen:
allOf:
- $ref: '#/definitions/CommonResponseType'
- properties:
order:
$ref: '#/definitions/OrderForEvergreen'
type: object
GetOrderResume:
description: 'Information about an order action of type `Resume`.
'
properties:
extendsTerm:
description: 'Specifies whether to extend the subscription term by the length
of time the suspension is in effect. Note this field is not applicable in
a Resume order action auto-created by the Order Metrics migration.
'
type: boolean
resumeDate:
description: 'The resume date when the resumption takes effect.
'
format: date
type: string
resumePeriods:
description: "This field is applicable only when the `resumePolicy` field\
\ is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It\
\ must be used together with the `resumePeriodsType` field. Note this field\
\ is not applicable in a Resume order action auto-created by the Order Metrics\
\ migration.\n\nThe total number of the periods used to specify when a subscription\
\ resumption takes effect. The subscription resumption will take place after\
\ the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`)\
\ from today's date. \n"
type: integer
resumePeriodsType:
description: "This field is applicable only when the `resumePolicy` field\
\ is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It\
\ must be used together with the `resumePeriods` field. Note this field\
\ is not applicable in a Resume order action auto-created by the Order Metrics\
\ migration.\n\nThe period type used to specify when a subscription resumption\
\ takes effect. The subscription suspension will take place after the specified\
\ time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from\
\ today's date. \n"
enum:
- Day
- Week
- Month
- Year
type: string
resumePolicy:
description: "Resume methods. Specify a way to resume a subscription. See\
\ [Resume Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Resume_a_Subscription#Resume_Date)\
\ for more information. Note this field is not applicable in a Resume order\
\ action auto-created by the Order Metrics migration.\n\nIf `SuspendDate`\
\ is specfied, the resumption will take place on the same day as the suspension.\
\ \n"
enum:
- Today
- FixedPeriodsFromSuspendDate
- FixedPeriodsFromToday
- SpecificDate
- SuspendDate
type: string
resumeSpecificDate:
description: |
This field is applicable only when the `resumePolicy` field is set to `SpecificDate`. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.
A specific date when the subscription resumption takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription suspension date.
format: date
type: string
title: Resume
type: object
GetOrderSuspend:
description: 'Information about an order action of type `Suspend`.
'
properties:
suspendDate:
description: "The suspend date when the suspension takes effect. \n"
format: date
type: string
suspendPeriods:
description: "This field is applicable only when the `suspendPolicy` field\
\ is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriodsType`\
\ field. Note this field is not applicable in a Suspend order action auto-created\
\ by the Order Metrics migration.\n\nThe total number of the periods used\
\ to specify when a subscription suspension takes effect. The subscription\
\ suspension will take place after the specified time frame (`suspendPeriods`\
\ multiplied by `suspendPeriodsType`) from today's date. \n"
type: integer
suspendPeriodsType:
description: "This field is applicable only when the `suspendPolicy` field\
\ is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriods`\
\ field. Note this field is not applicable in a Suspend order action auto-created\
\ by the Order Metrics migration.\n\nThe period type used to specify when\
\ a subscription suspension takes effect. The subscription suspension will\
\ take place after the specified time frame (`suspendPeriods` multiplied\
\ by `suspendPeriodsType`) from today's date. \n"
enum:
- Day
- Week
- Month
- Year
type: string
suspendPolicy:
description: 'Suspend methods. Specify a way to suspend a subscription. See
[Suspend Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Suspend_a_Subscription#Suspend_Date)
for more information. Note this field is not applicable in a Suspend order
action auto-created by the Order Metrics migration.
'
enum:
- Today
- EndOfLastInvoicePeriod
- FixedPeriodsFromToday
- SpecificDate
type: string
suspendSpecificDate:
description: |
This field is applicable only when the `suspendPolicy` field is set to `SpecificDate`. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration.
A specific date when the subscription suspension takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription's contract effective date or later than the subscription's term end date.
format: date
type: string
title: Suspend
type: object
GetSubscriptionTermInfoResponseType:
allOf:
- $ref: '#/definitions/CommonResponseType'
- properties:
nextPage:
description: 'The URL of the next page of terms.
'
format: URL
type: string
terms:
items:
$ref: '#/definitions/Term'
type: array
type: object
InitialTerm:
description: The length of the period for the current subscription term.
properties:
period:
description: Specify only when the termType is 'TERMED'.
minimum: 0
type: integer
periodType:
description: Specify only when the termType is 'TERMED'.
enum:
- Month
- Year
- Day
- Week
type: string
startDate:
description: 'The start date of the current term.
'
format: date
type: string
termType:
enum:
- TERMED
- EVERGREEN
type: string
required:
- termType
type: object
Invoice:
properties:
AccountId:
description: ''
type: string
AdjustmentAmount:
description: " The amount of the invoice adjustments associated with the invoice.\
\ **Character limi**t: 16\n\n**Values**: a valid currency amount "
format: double
type: number
Amount:
description: " The sum of all charges and taxes associated with the invoice.\n\
\n\n**Character limit**: 16\n\n**Values**: automatically generated "
format: double
type: number
AmountWithoutTax:
description: " The sum of all charges associated with the invoice. Taxes are\
\ excluded from this value.\n\n\n**Character limit**: 16\n\n**Values**:\
\ automatically generated "
format: double
type: number
Balance:
description: " The remaining balance of the invoice after all payments, adjustments,\
\ and refunds are applied.\n\n\n**Character limit**: 16\n\n**Values**: automatically\
\ generated "
format: double
type: number
BillRunId:
description: " The ID of a Bill Run.\n\n\n**Character limit**: 32\n\n**Values**:\
\ a BillRun ID "
type: string
Body:
description: ' Required '
type: string
Comments:
description: " Additional information related to the invoice that a Zuora\
\ user added to the invoice.\n\n\n**Character limit**: 255\n\n**Values:**\
\ a string of 255 characters or fewer "
type: string
CreatedById:
description: " The user ID of the person who created the invoice. If a bill\
\ run generated the invoice, then the value is the user ID of person who\
\ created the bill run.\n\n\n**Character limit**: 32\n\n**Values**: automatically\
\ generated "
type: string
CreatedDate:
description: " The date when the invoice was generated.\n\n\n**Character limit**:\
\ 29\n\n**Values**: automatically generated "
format: date-time
type: string
CreditBalanceAdjustmentAmount:
description: |2+
The currency amount of the adjustment applied to the customer's credit balance.
**Character limit**: 16
**Values**: a valid currency amount This field is only available if the [Zuora Global Support](http://support.zuora.com/) to enable this feature.
format: double
type: number
DueDate:
description: " The date by which the payment for this invoice is due.\n\n\n\
**Character limit**: 29 "
format: date
type: string
IncludesOneTime:
description: " Specifies whether the invoice includes one-time charges.\n\n\
\n**Character limit**: 5\n\n**Values**: automatically generated from one\
\ of the following: `True` (default), `False` "
type: boolean
IncludesRecurring:
description: " Specifies whether the invoice includes recurring charges.\n\
\n\n**Character limit**: 5\n\n**Values**: automatically generated from one\
\ of the following: `True` (default), `False` "
type: boolean
IncludesUsage:
description: " Specifies whether the invoice includes usage charges.\n\n\n\
**Character limit**: 5\n\n**Values**: automatically generated from one of\
\ the following: `True `(default), `False` "
type: boolean
InvoiceDate:
description: " Specifies the date on which to generate the invoice.\n\n\n\
**Character limit**: 29 "
format: date
type: string
InvoiceNumber:
description: " The unique identification number for the invoice. This number\
\ is returned as a string.\n\n\n**Character limit**: 32\n\n**Values**: automatically\
\ generated "
type: string
LastEmailSentDate:
description: " The date when the invoice was last emailed.\n\n\n**Character\
\ limit**: 29\n\n**Values**: automatically generated "
format: date-time
type: string
PaymentAmount:
description: " The amount of payments applied to the invoice.\n\n\n**Character\
\ limit**: 16 **Value**s: automatically generated "
format: double
type: number
PostedBy:
description: " The user ID of the person who moved the invoice to Posted status.\n\
\n\n**Character limit**: 32\n\n**Values**: automatically generated "
type: string
PostedDate:
description: " The date when the invoice was posted.\n\n\n**Character limit:**\
\ 29\n\n**Values**: automatically generated "
format: date-time
type: string
RefundAmount:
description: " Specifies the amount of a refund that was applied against an\
\ earlier payment on the invoice.\n\n\n**Character limit**: 16\n\n**Values**:\
\ automatically generated "
format: double
type: number
RegenerateInvoicePDF:
description: " Regenerates a PDF of an invoice that was already generated.\n\
\n**Character limit**: 5\n\n**Values**: `True`, `False` "
type: boolean
Status:
description: |2+
The status of the invoice in the system. This status is not the status of the payment of the invoice, just the status of the invoice itself.
**Character limit**: 8
**Values**: one of the following:
- Draft (default, automatically set upon invoice creation)
- Posted
- Canceled
type: string
TargetDate:
description: " This date is used to determine which charges are to be billed.\
\ All charges that are to be billed on this date or prior will be included\
\ in this bill run.\n\n\n**Character limit**: 29 "
format: date
type: string
TaxAmount:
description: " The total amount of the taxes applied to the invoice.\n\n\n\
**Character limit**: 16\n\n**Values**: automatically generated "
format: double
type: number
TaxExemptAmount:
description: " The calculated tax amount excluded due to the exemption.\n\n\
\n**Character limit**: 16\n\n**Values**: automatically generated "
format: double
type: number
TransferredToAccounting:
description: " Specifies whether or not the invoice was transferred to an\
\ external accounting system, such as NetSuite.\n\n\n**Character limit**:\
\ 10\n\n**Values**: Processing, Yes, Error, Ignore "
type: string
UpdatedById:
description: ''
type: string
UpdatedDate:
description: " The date when the invoice was last updated.\n\n\n**Character\
\ limit**: 29\n\n**Values**: automatically generated "
format: date-time
type: string
type: object
InvoiceAdjustmentObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Invoice Adjustment 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 Invoice Adjustment object.
'
title: invoiceAdjustmentFieldsCustom
type: object
InvoiceDataInvoice:
allOf:
- properties:
AccountId:
description: ''
type: string
AdjustmentAmount:
description: " The amount of the invoice adjustments associated with the\
\ invoice. **Character limi**t: 16\n\n\n**Values**: a valid currency amount "
format: double
type: number
Amount:
description: " The sum of all charges and taxes associated with the invoice.\n\
\n\n**Character limit**: 16\n\n\n**Values**: automatically generated "
format: double
type: number
AmountWithoutTax:
description: " The sum of all charges associated with the invoice. Taxes\
\ are excluded from this value.\n\n\n**Character limit**: 16\n\n\n**Values**:\
\ automatically generated "
format: double
type: number
Balance:
description: " The remaining balance of the invoice after all payments,\
\ adjustments, and refunds are applied.\n\n\n**Character limit**: 16\n\
\n\n**Values**: automatically generated "
format: double
type: number
BillRunId:
description: " The ID of a Bill Run.\n\n\n**Character limit**: 32\n\n\n\
**Values**: a BillRun ID "
type: string
Body:
description: ' Required '
type: string
Comments:
description: " Additional information related to the invoice that a Zuora\
\ user added to the invoice.\n\n\n**Character limit**: 255 **Values:**\
\ a string of 255 characters or fewer "
type: string
CreatedById:
description: " The user ID of the person who created the invoice. If a bill\
\ run generated the invoice, then the value is the user ID of person who\
\ created the bill run.\n\n\n**Character limit**: 32\n\n\n**Values**:\
\ automatically generated "
type: string
CreatedDate:
description: " The date when the invoice was generated.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
CreditBalanceAdjustmentAmount:
description: |2+
The currency amount of the adjustment applied to the customer's credit balance.
**Character limit**: 16
**Values**: a valid currency amount This field is only available if the [Zuora Global Support](http://support.zuora.com/) to enable this feature.
format: double
type: number
DueDate:
description: " The date by which the payment for this invoice is due.\n\n\
\n**Character limit**: 29 "
format: date
type: string
IncludesOneTime:
description: " Specifies whether the invoice includes one-time charges.\
\ You can use this field only with the `generate\n` call for the Invoice\
\ object.\n\n\n**Character limit**: 5\n\n\n**Values**: automatically generated\
\ from one of the following: `True` (default), `False` "
type: boolean
IncludesRecurring:
description: " Specifies whether the invoice includes recurring charges.\
\ You can use this field only with the `generate\n`call for the Invoice\
\ object.\n\n\n**Character limit**: 5\n\n\n**Values**: automatically generated\
\ from one of the following: `True` (default), `False` "
type: boolean
IncludesUsage:
description: " Specifies whether the invoice includes usage charges. You\
\ can use this field only with the `generate\n`call for the Invoice object.\n\
\n\n**Character limit**: 5\n\n\n**Values**: automatically generated from\
\ one of the following: `True `(default), `False` "
type: boolean
InvoiceDate:
description: " Specifies the date on which to generate the invoice.\n\n\n\
**Character limit**: 29 "
format: date
type: string
InvoiceNumber:
description: " The unique identification number for the invoice. This number\
\ is returned as a string.\n\n\n**Character limit**: 32\n\n\n**Values**:\
\ automatically generated "
type: string
LastEmailSentDate:
description: " The date when the invoice was last emailed.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
PaymentAmount:
description: " The amount of payments applied to the invoice.\n\n\n**Character\
\ limit**: 16 **Value**s: automatically generated "
format: double
type: number
PostedBy:
description: " The user ID of the person who moved the invoice to Posted\
\ status.\n\n\n**Character limit**: 32\n\n\n**Values**: automatically\
\ generated "
type: string
PostedDate:
description: " The date when the invoice was posted.\n**Character limit:**\
\ 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
RefundAmount:
description: " Specifies the amount of a refund that was applied against\
\ an earlier payment on the invoice.\n\n\n**Character limit**: 16\n\n\n\
**Values**: automatically generated "
format: double
type: number
RegenerateInvoicePDF:
description: " Regenerates a PDF of an invoice that was already generated.\
\ Add this field to an `update\n` call to regenerate an invoice PDF. Note\
\ that when you set the `RegenerateInvoicePDF` field to `true`, you cannot\
\ update any other fields in the same `update\n` call. Otherwise, you\
\ will receive the following `INVALID_VALUE` error: "When field RegenerateInvoicePDF\
\ is set to true to regenerate the invoice PDF file, changes on other\
\ fields of the invoice are not allowed."\n\n**Character limit**:\
\ 5\n\n\n**Values**: `True`, `False` "
type: boolean
Status:
description: |2+
The status of the invoice in the system. This status is not the status of the payment of the invoice, just the status of the invoice itself.
**Character limit**: 8
**Values**: one of the following:
- Draft (default, automatically set upon invoice creation)
- Posted
- Canceled
type: string
TargetDate:
description: " This date is used to determine which charges are to be billed.\
\ All charges that are to be billed on this date or prior will be included\
\ in this bill run.\n\n\n**Character limit**: 29 "
format: date
type: string
TaxAmount:
description: " The total amount of the taxes applied to the invoice.\n\n\
\n**Character limit**: 16\n\n\n**Values**: automatically generated "
format: double
type: number
TaxExemptAmount:
description: " The calculated tax amount excluded due to the exemption.\n\
\n\n**Character limit**: 16\n\n\n**Values**: automatically generated "
format: double
type: number
TransferredToAccounting:
description: " Specifies whether or not the invoice was transferred to an\
\ external accounting system, such as NetSuite.\n\n\n**Character limit**:\
\ 10\n\n\n**Values**: Processing, Yes, Error, Ignore "
type: string
UpdatedById:
description: ''
type: string
UpdatedDate:
description: " The date when the invoice was last updated.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
type: object
- $ref: '#/definitions/InvoiceObjectNSFields'
- $ref: '#/definitions/InvoiceObjectCustomFields'
description: ''
title: Invoice
InvoiceItemAdjustmentObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Invoice Item Adjustment 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 Invoice Item Adjustment object.
'
title: invoiceItemAdjustmentFieldsCustom
type: object
InvoiceItemAdjustmentObjectNSFields:
description: 'Container for Invoice Item Adjustment fields provided by the [Zuora
Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
properties:
InvoiceItemAdjustment.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
InvoiceItemAdjustment.IntegrationStatus__NS:
description: 'Status of the invoice item adjustment''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
InvoiceItemAdjustment.SyncDate__NS:
description: 'Date when the invoice item adjustment was synchronized with
NetSuite. Only available if you have installed the [Zuora Connector for
NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
title: invoiceItemAdjustmentFieldsNS
type: object
InvoiceItemObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Invoice Item 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 Invoice Item object.
'
title: invoiceItemFieldsCustom
type: object
InvoiceItemObjectNSFields:
description: 'Container for Invoice Item fields provided by the [Zuora Connector
for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
properties:
IntegrationId__NS:
description: 'ID of the corresponding object in NetSuite. Only available if
you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
IntegrationStatus__NS:
description: 'Status of the invoice item''s synchronization with NetSuite.
Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
SyncDate__NS:
description: 'Date when the invoice item was synchronized with NetSuite. Only
available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
title: invoiceItemFieldsNS
type: object
InvoiceObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Invoice 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 Invoice object.
'
title: invoiceFieldsCustom
type: object
InvoiceObjectNSFields:
description: 'Container for Invoice fields provided by the [Zuora Connector for
NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
properties:
IntegrationId__NS:
description: 'ID of the corresponding object in NetSuite. Only available if
you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
IntegrationStatus__NS:
description: 'Status of the invoice''s synchronization with NetSuite. Only
available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
SyncDate__NS:
description: 'Date when the invoice was synchronized with NetSuite. Only available
if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
title: invoiceFieldsNS
type: object
InvoicePayment:
properties:
Amount:
description: 'The amount of the payment to apply to an invoice.
'
format: decimal
type: string
InvoiceId:
description: 'The ID of the invoice that the payment is applied to.
'
type: string
PaymentId:
description: 'The ID of the payment.
'
type: string
required:
- Amount
- InvoiceId
type: object
InvoiceProcessingOptions:
properties:
InvoiceDate:
description: ' The invoice date.'
format: date
type: string
InvoiceTargetDate:
description: ' The date that determines which charges to bill. Charges prior
to this date or on this date are billed on the resulting invoices. '
format: date
type: string
required:
- InvoiceTargetDate
type: object
NewChargeMetrics:
properties:
ChargeNumber:
description: ''
type: string
DMRR:
description: ''
format: double
type: number
DTCV:
description: ''
format: double
type: number
MRR:
description: ''
format: double
type: number
OriginalId:
description: ''
type: string
OriginalRatePlanId:
description: ''
type: string
ProductRatePlanChargeId:
description: ''
type: string
ProductRatePlanId:
description: ''
type: string
TCV:
description: ''
format: double
type: number
type: object
OneTimeFlatFeePricingOverride:
description: 'Pricing information about a one-time charge that uses the "flat
fee" charge model. In this charge model, the charge has a fixed price.
'
properties:
listPrice:
description: 'Price of the charge.
'
type: number
required:
- listPrice
title: oneTimeFlatFee
type: object
OneTimePerUnitPricingOverride:
description: 'Pricing information about a one-time charge that uses the "per unit"
charge model. In this charge model, the charge has a fixed price per unit purchased.
'
properties:
listPrice:
description: 'Per-unit price of the charge.
'
type: number
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
title: oneTimePerUnit
type: object
OneTimeTieredPricingOverride:
description: 'Pricing information about a one-time charge that uses the "tiered
pricing" charge model. In this charge model, the charge has cumulative pricing
tiers that become effective as units are purchased.
'
properties:
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
tiers:
description: 'List of cumulative pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
title: oneTimeTiered
type: object
OneTimeVolumePricingOverride:
description: 'Pricing information about a one-time charge that uses the "volume
pricing" charge model. In this charge model, the charge has a variable price
per unit, depending on how many units are purchased.
'
properties:
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
tiers:
description: 'List of variable pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
title: oneTimeVolume
type: object
OrderActionForEvergreen:
description: Represents the processed order action.
properties:
addProduct:
$ref: '#/definitions/RatePlanOverrideForEvergreen'
cancelSubscription:
$ref: '#/definitions/CancelSubscription'
changePlan:
$ref: '#/definitions/ChangePlan'
createSubscription:
$ref: '#/definitions/CreateSubscriptionForEvergreen'
customFields:
$ref: '#/definitions/OrderActionObjectCustomFields'
id:
description: The Id of the order action processed in the order.
type: string
orderMetrics:
description: 'Shows the delta metrics caused by a specific order action on
a specific charge.
'
items:
$ref: '#/definitions/OrderMetricsForEvergreen'
type: array
ownerTransfer:
$ref: '#/definitions/OwnerTransfer'
removeProduct:
$ref: '#/definitions/RemoveProduct'
renewSubscription:
$ref: '#/definitions/RenewSubscription'
resume:
$ref: '#/definitions/GetOrderResume'
sequence:
description: The sequence of the order actions processed in the order.
type: integer
suspend:
$ref: '#/definitions/GetOrderSuspend'
termsAndConditions:
$ref: '#/definitions/TermsAndConditions'
triggerDates:
description: "Container for the contract effective, service activation, and\
\ customer acceptance dates of the order action. \n\nIf [Zuora is configured\
\ to require service activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F)\
\ and the `ServiceActivation` field is not set for a `CreateSubscription`\
\ order action, a `Pending` order and a `Pending Activation` subscription\
\ are created.\n\nIf [Zuora is configured to require customer acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F)\
\ and the `CustomerAcceptance` field is not set for a `CreateSubscription`\
\ order action, a `Pending` order and a `Pending Acceptance` subscription\
\ are created. At the same time, if the service activation date field is\
\ also required and not set, a `Pending` order and a `Pending Activation`\
\ subscription are created instead.\n\nIf [Zuora is configured to require\
\ service activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F)\
\ and the `ServiceActivation` field is not set for either of the following\
\ order actions, a `Pending` order is created. The subscription status is\
\ not impacted. **Note:** This feature is in **Limited Availability**. If\
\ you want to have access to the feature, submit a request at [Zuora Global\
\ Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n\
\ * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n\nIf [Zuora\
\ is configured to require customer acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F)\
\ and the `CustomerAcceptance` field is not set for either of the following\
\ order actions, a `Pending` order is created. The subscription status is\
\ not impacted. **Note:** This feature is in **Limited Availability**. If\
\ you want to have access to the feature, submit a request at [Zuora Global\
\ Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n\
\ * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
items:
$ref: '#/definitions/TriggerDate'
type: array
type:
description: Type of the order action.
enum:
- CreateSubscription
- ChangePlan
- TermsAndConditions
- AddProduct
- UpdateProduct
- RemoveProduct
- RenewSubscription
- CancelSubscription
- OwnerTransfer
- Suspend
- Resume
type: string
updateProduct:
$ref: '#/definitions/RatePlanUpdateForEvergreen'
type: object
OrderActionObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Order Action 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 Order Action object.
'
title: orderActionFieldsCustom
type: object
OrderForEvergreen:
description: Represents the order information that will be returned in the GET
call.
properties:
createdBy:
description: The ID of the user who created this order.
type: string
createdDate:
description: The time that the order gets created in the system, in the `YYYY-MM-DD
HH:MM:SS` format.
format: datetime
type: string
currency:
description: Currency code.
type: string
customFields:
$ref: '#/definitions/OrderObjectCustomFields'
description:
description: A description of the order.
maxLength: 500
type: string
existingAccountNumber:
description: The account number that this order has been created under. This
is also the invoice owner of the subscriptions included in this order.
type: string
orderDate:
description: The date when the order is signed. All the order actions under
this order will use this order date as the contract effective date if no
additinal contractEffectiveDate is provided.
format: datetime
type: string
orderNumber:
description: The order number of the order.
type: string
status:
description: The status of the order.
type: string
invoiceScheduleId:
description: |
The ID of the invoice schedule associated with the order.
**Note**: This field is available only if you have the Billing Schedule feature enabled.
type: string
subscriptions:
description: Represents a processed subscription, including the origin request
(order actions) that create this version of subscription and the processing
result (order metrics). The reference part in the request will be overridden
with the info in the new subscription version.
items:
properties:
baseVersion:
description: The base version of the subscription.
type: integer
customFields:
$ref: '#/definitions/SubscriptionObjectCustomFields'
newVersion:
description: The latest version of the subscription.
type: integer
orderActions:
items:
$ref: '#/definitions/OrderActionForEvergreen'
type: array
quote:
$ref: '#/definitions/QuoteObjectFields'
sequence:
description: The sequence number of a certain subscription processed
by the order.
type: integer
subscriptionNumber:
description: The new subscription number for a new subscription created,
or the existing subscription number. Unlike the order request, the
subscription number here always has a value.
type: string
type: object
type: array
updatedBy:
description: The ID of the user who updated this order.
type: string
updatedDate:
description: The time that the order gets updated in the system (for example,
an order description update), in the `YYYY-MM-DD HH:MM:SS` format.
format: datetime
type: string
type: object
OrderMetricsForEvergreen:
properties:
chargeNumber:
type: string
mrr:
items:
$ref: '#/definitions/TimeSlicedNetMetricsForEvergreen'
type: array
originRatePlanId:
type: string
productRatePlanChargeId:
type: string
productRatePlanId:
type: string
quantity:
items:
$ref: '#/definitions/TimeSlicedMetricsForEvergreen'
type: array
tcb:
description: Total contracted billing which is the forecast value for the
total invoice amount.
items:
$ref: '#/definitions/TimeSlicedTcbNetMetricsForEvergreen'
type: array
tcv:
description: Total contracted value.
items:
$ref: '#/definitions/TimeSlicedNetMetricsForEvergreen'
type: array
type: object
OrderObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Order 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 Order object.
'
title: orderFieldsCustom
type: object
OwnerTransfer:
description: |
Information about an order action of type `OwnerTransfer`.
**Note:** The Owner Transfer feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
properties:
billToContactId:
description: |
The contact id of the bill to contact that the subscription is being transferred to.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
clearingExistingBillToContact:
default: false
description: |
Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `paymentTerm` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingInvoiceTemplate:
default: false
description: |
Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingPaymentTerm:
default: false
description: |
Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `billToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingSequenceSet:
default: false
description: |
Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
destinationAccountNumber:
description: 'The account number of the account that the subscription is being
transferred to.
'
type: string
destinationInvoiceAccountNumber:
description: 'The account number of the invoice owner account that the subscription
is being transferred to.
'
type: string
invoiceTemplateId:
description: |
The ID of the invoice template associated with the subscription.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
paymentTerm:
description: 'Name of the payment term associated with the account. For example,
"Net 30". The payment term determines the due dates of invoices.
'
type: string
sequenceSetId:
description: |
The ID of the sequence set associated with the subscription.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
title: ownerTransfer
type: object
POSTCatalogType:
example:
targetEntityIds:
- 8a80825555a3c7a10155b460f53858e6
properties:
toEntityIds:
description: 'The entity that you want to share the product with.
'
items:
title: Entity IDs
type: string
type: array
required:
- toEntityIds
type: object
POSTCmiRevenueScheduleByTransactionType:
allOf:
- properties:
notes:
description: |
Additional information about this record.
Character Limit: 2,000
type: string
revenueDistributions:
description: |
An array of revenue distributions. Represents how you want to distribute revenue for this revenue schedule. You can distribute revenue into a maximum of 250 accounting periods with one revenue schedule.
The sum of new Amounts must equal the the Charge Amount of the specified Invoice Item.
items:
$ref: '#/definitions/POSTDistributionItemType'
type: array
revenueEvent:
$ref: '#/definitions/POSTRevenueScheduleByTransactionTypeRevenueEvent'
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
example:
revenueDistributions:
- accountingPeriodName: Jan '16
newAmount: '20'
- accountingPeriodName: Open-Ended
newAmount: '30'
revenueEvent:
eventType: Revenue Distributed
eventTypeSystemId: RevenueDistributed__z
notes: My notes
POSTDistributionItemType:
properties:
accountingPeriodName:
description: "Name of the accounting period. The open-ended accounting period\
\ is named `Open-Ended`. \n\nThe accounting period must be open.\n"
type: string
newAmount:
description: |
Amount of revenue you want to distribute into the accounting period.
The value must be formatted based on the currency, for example, `JPY 30` or `USD 30.15`. If the value is formatted incorrectly, the following error message is returned: `Allocation amount with wrong decimal places.`
format: decimal
type: string
required:
- accountingPeriodName
- newAmount
title: revenueDistributions
type: object
POSTDmiRevenueScheduleByTransactionType:
allOf:
- properties:
notes:
description: |
Additional information about this record.
Character Limit: 2,000
type: string
revenueDistributions:
description: |
An array of revenue distributions. Represents how you want to distribute revenue for this revenue schedule. You can distribute revenue into a maximum of 250 accounting periods with one revenue schedule.
The sum of new Amounts must equal the the Charge Amount of the specified Invoice Item.
items:
$ref: '#/definitions/POSTDistributionItemType'
type: array
revenueEvent:
$ref: '#/definitions/POSTRevenueScheduleByTransactionTypeRevenueEvent'
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
example:
revenueDistributions:
- accountingPeriodName: Jan '16
newAmount: '20'
- accountingPeriodName: Open-Ended
newAmount: '30'
revenueEvent:
eventType: Revenue Distributed
eventTypeSystemId: RevenueDistributed__z
notes: My notes
POSTDocumentPropertiesType:
example:
customFileName: testCreditMemo
documentId: 40288af1614cee0b01614cf2ec25000a
documentType: CreditMemo
properties:
customFileName:
description: 'The custom file name to use to generate new Word or PDF files
for the billing document.
'
type: string
documentKey:
description: |
The unique ID or number of a billing document that you want to create document properties for.
For example, 402892c74c9193cd014c96bbe7c101f9, INV00000001, CM00000001, or DM00000001.
type: string
documentType:
description: "The type of the billing document. \n"
enum:
- Invoice
- CreditMemo
- DebitMemo
type: string
type: object
POSTEntityConnectionsResponseType:
properties:
id:
description: 'The ID of the connection that you just initiated.
'
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
POSTEntityConnectionsType:
example:
targetEntityId: 8a80825556ff28a4015708ba29312ecc
properties:
targetEntityId:
description: 'The ID of the target entity that you want to connect with. You
can get the entity Id using the Multi-entity: Get entities call.
'
maxLength: 32
type: string
required:
- targetEntityId
type: object
POSTHMACSignatureResponseType:
properties:
signature:
description: |
Contains a keyed-hash message authentication code (HMAC)
e.g. `ZmI0ZjE2ZTMxMWY1YjA0ZTc4MTg1ZDhlYWRkMTEwNDE3M2RiMzNiNQ==<`
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
token:
description: 'Contains a token code. e.g. `gCH6gYqQffQCsFKSLuxyagXsuXcIK0uf`
'
type: string
type: object
POSTHMACSignatureType:
example:
accountKey: A00000001
method: POST
uri: https://rest.zuora.com/v1/payment-methods/credit-cards
properties:
accountKey:
description: |
Customer account number or ID.
Specifies this field only when creating signatures for Create payment method.
type: string
method:
description: 'Possible values are: ''GET'', ''POST'', ''PUT'', ''DELETE'',
''OPTIONS''.
'
type: string
name:
description: |
Account name.
Specifies this field only when creating signatures for Create account.
type: string
pageId:
description: |
The page id of your Payment Pages 2.0 form. Click **Show Page Id** next to the Payment Page name in the Hosted Page List to retrieve the page id.
Specifies this field only when creating signatures for RSA Signatures.
type: string
uri:
description: |
The URI of the API object the customer will make a CORS enabled call to.
e.g. "https://rest.zuora.com/v1/payment-methods/credit-cards"
type: string
required:
- uri
- method
type: object
POSTIiaRevenueScheduleByDateRangeType:
allOf:
- properties:
distributionType:
description: "How you want to distribute the revenue. \n\n\n* Daily Distribution:\
\ Distributes revenue evenly across each day between the recognitionStart\
\ and recognitionEnd dates.\n* Monthly Distribution (Back Load): Back\
\ loads the revenue so you distribute the monthly amount in the partial\
\ month in the end only.\n* Monthly Distribution (Front Load): Front loads\
\ the revenue so you distribute the monthly amount in the partial month\
\ in the beginning only.\n* Monthly Distribution (Proration by Days):\
\ Splits the revenue amount between the two partial months.\n\n**Note:**\
\ To use any of the Monthly Distribution options, you must have the \"\
Monthly recognition over time\" model enabled in **Settings > Finance\
\ > Manage Revenue Recognition Models** in the Zuora UI.\n"
enum:
- Daily Distribution
- Monthly Distribution (Back Load)
- Monthly Distribution (Front Load)
- Monthly Distribution (Proration by Days)
type: string
notes:
description: 'Additional information about this record.
'
type: string
recognitionEnd:
description: "The end date of a recognition period in `yyyy-mm-dd` format.\
\ \n\nThe maximum difference between the `recognitionStart` and `recognitionEnd`\
\ date fields is equal to 250 multiplied by the length of an accounting\
\ period.\n"
format: date
type: string
recognitionStart:
description: |
The start date of a recognition period in `yyyy-mm-dd` format.
If there is a closed accounting period between the `recognitionStart` and `recognitionEnd` dates, the revenue that would be placed in the closed accounting period is instead placed in the next open accounting period.
format: date
type: string
revenueEvent:
$ref: '#/definitions/POSTRevenueScheduleByDateRangeTypeRevenueEvent'
required:
- recognitionEnd
- recognitionStart
- revenueEvent
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
example:
distributionType: Daily distribution
notes: Manually distribute revenue by usage
recognitionEnd: '2016-12-31'
recognitionStart: 2016-12-1
revenueEvent:
eventType: Revenue Distributed
eventTypeSystemId: RevenueDistributed__z
notes: ''
POSTIiaRevenueScheduleByTransactionType:
allOf:
- properties:
notes:
description: |
Additional information about this record.
Character Limit: 2,000
type: string
revenueDistributions:
description: |
An array of revenue distributions. Represents how you want to distribute revenue for this revenue schedule. You can distribute revenue into a maximum of 250 accounting periods with one revenue schedule.
The sum of new Amounts must equal the the Charge Amount of the specified Invoice Item.
items:
$ref: '#/definitions/POSTDistributionItemType'
type: array
revenueEvent:
$ref: '#/definitions/POSTRevenueScheduleByTransactionTypeRevenueEvent'
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
example:
revenueDistributions:
- accountingPeriodName: Jan '16
newAmount: '20'
- accountingPeriodName: Open-Ended
newAmount: '30'
revenueEvent:
eventType: Revenue Distributed
eventTypeSystemId: RevenueDistributed__z
notes: My notes
POSTPaymentMethodResponseType:
properties:
paymentMethodId:
description: 'ID of the newly-created payment method.
'
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
POSTPaymentMethodType:
allOf:
- properties:
accountKey:
description: |-
ID of the customer account.
To create an orphan payment method that is not associated with any customer account, you do not need to specify this field during creation. However, you must associate the orphan payment method with a customer account within 10 days. Otherwise, this orphan payment method will be deleted.
type: string
cardHolderInfo:
$ref: '#/definitions/CreatePaymentMethodCardholderInfo'
creditCardNumber:
description: 'Credit card number, a string of up to 16 characters. This
field can only be set when creating a new payment method; it cannot be
queried or updated.
'
type: string
creditCardType:
description: |
The type of the credit card.
Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).
type: string
defaultPaymentMethod:
description: 'Specify true to make this card the default payment method;
otherwise, omit this parameter to keep the current default payment method.
'
type: boolean
expirationMonth:
description: 'One or two digits expiration month (1-12).
'
type: integer
expirationYear:
description: 'Four-digit expiration year.
'
type: integer
gatewayOptions:
description: |
The field used to pass gateway-specific parameters and parameter values.
Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
properties:
key:
description: 'The name of a gateway-specific parameter.
'
type: string
value:
description: 'The value of the gateway-specific parameter.
'
type: string
type: object
mitConsentAgreementRef:
description: 'Specifies your reference for the stored credential consent
agreement that you have established with the customer. Only applicable
if you set the `mitProfileAction` field.
'
maxLength: 128
type: string
mitConsentAgreementSrc:
description: 'Required if you set the `mitProfileAction` field. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.
'
enum:
- External
type: string
mitNetworkTransactionId:
description: 'Specifies the ID of a network transaction. Only applicable
if you set the `mitProfileAction` field to `Persist`.
'
maxLength: 128
type: string
mitProfileAction:
description: 'Specifies how Zuora creates and activates a stored credential profile. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.'
enum:
- Activate
- Persist
type: string
mitProfileAgreedOn:
description: "The date on which the profile is agreed. The date format is\
\ `yyyy-mm-dd`. \n"
format: date
type: string
mitProfileType:
description: 'Required if you set the `mitProfileAction` field. Indicates
the type of the stored credential profile to process recurring or unsecheduled
transactions. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.
'
enum:
- Recurring
- Unscheduled
type: string
numConsecutiveFailures:
description: "The number of consecutive failed payments for this payment\
\ method. It is reset to `0` upon successful payment. \n"
format: int32
maximum: 100
minimum: 0
type: integer
securityCode:
description: 'The CVV or CVV2 security code for the credit card or debit
card. Only required if changing expirationMonth, expirationYear, or cardHolderName.
To ensure PCI compliance, this value isn''t stored and can''t be queried.
'
type: string
required:
- creditCardType
- creditCardNumber
- expirationMonth
- expirationYear
type: object
- $ref: '#/definitions/PaymentMethodObjectCustomFields'
example:
accountKey: 8ad09be48db5aba7018db604776d4854
creditCardType: Visa
creditCardNumber: '4111111111111111'
expirationMonth: 10
expirationYear: 2021
POSTQuoteDocResponseType:
properties:
file:
description: 'URL of the generated quote document if the file was successfully
generated.
'
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
POSTQuoteDocType:
example:
apiuser: contact@example.com
documentType: pdf
locale: en_US
quoteId: a0Bi000000A71rp
serverUrl: https://c.na10.visual.force.com/services/Soap/u/10.0/00DF00000008VnX
sessionId: we764buuM03bkE0fmmc5zGMYp
templateId: 4028925648fdb7830148fdc1246c0003
useSFDCLocale: '1'
zquotesMajorVersion: '7'
zquotesMinorVersion: '0'
properties:
apiuser:
description: 'If not using Salesforce locale, this API Zuora user will be
used to retrieve the locale from Zuora.
'
type: string
documentType:
description: 'Type of the document to generate: `PDF` or `DOC`.
'
type: string
locale:
description: 'Salesforce locale value to use.
'
type: string
password:
description: ''
type: string
quoteId:
description: "\uFF5C Id of the quote\u3002"
type: string
sandbox:
description: ''
type: string
serverUrl:
description: 'SOAP URL used to login to Salesforce to get data. You can get
the value with the following code in a Visualforce page: `{!$Api.Partner_Server_URL_100}`
'
type: string
sessionId:
description: 'Salesforce session id used to log in to Salesforce to get data.
You can get the value with the following code in a Visualforce page: *{!$Api.Session_ID}*
'
type: string
templateId:
description: 'Id of the quote template in Zuora.
'
type: string
token:
description: ''
type: string
useSFDCLocale:
description: 'If using Salesforce org locale, set this to a value that is
not null.
'
type: string
username:
description: ''
type: string
zquotesMajorVersion:
description: |
The major version number of Zuora Quotes you are generating the quote document in.
You can use a quote template with hierarchy sizes bigger than 3 if this is set to 7 or higher.
type: string
zquotesMinorVersion:
description: 'The minor version number of Zuora Quotes you are generating
the quote document in.
'
type: string
required:
- documentType
- quoteId
- serverUrl
- templateId
- sessionId
type: object
POSTRevenueScheduleByChargeResponseType:
properties:
revenueScheduleNumber:
description: 'Revenue schedule number. The revenue schedule number is always
prefixed with "RS", for example, "RS-00000001".
'
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
POSTRevenueScheduleByChargeType:
allOf:
- properties:
amount:
description: 'The revenue schedule amount, which is the sum of all revenue
items. This field cannot be null and must be formatted based on the currency,
such as `JPY 30` or `USD 30.15`. Test out the currency to ensure you are
using the proper formatting otherwise, the response will fail and this
error message is returned: `Allocation amount with wrong decimal places.`
'
format: decimal
type: string
deferredRevenueAccountingCode:
description: 'The accounting code for deferred revenue, such as Monthly
Recurring Liability. Required only when `overrideChargeAccountingCodes`
is `true`. Otherwise, this value is ignored.
'
type: string
deferredRevenueAccountingCodeType:
description: 'The type of the deferred revenue accounting code, such as
Deferred Revenue. Required only when `overrideChargeAccountingCodes` is
`true`. Otherwise, this value is ignored.
'
type: string
notes:
description: |
Additional information about this record.
Character Limit: 2,000
type: string
overrideChargeAccountingCodes:
default: false
description: 'When overriding accounting codes from a charge, `recognizedRevenueAccountingCode`
and `deferredRevenue AccountingCode` must be in the request body and can
have the empty value.
'
enum:
- true
- false
type: boolean
recognizedRevenueAccountingCode:
description: 'The accounting code for recognized revenue, such as Monthly
Recurring Charges or Overage Charges. Required only when `overrideChargeAccountingCodes`
is `true`. Otherwise, the value is ignored.
'
type: string
recognizedRevenueAccountingCodeType:
description: 'The type of the recognized revenue accounting code, such as
Sales Revenue or Sales Discount. Required only when `overrideChargeAccountingCodes`
is `true`. Otherwise, this value is ignored.
'
type: string
referenceId:
description: |
Reference ID is used only in the custom unlimited rule to create a revenue schedule. In this scenario, the revenue schedule is not linked to an invoice item or invoice item adjustment.
Character Limit: 100
type: string
revenueDistributions:
description: |
An array of revenue distributions. Represents how you want to distribute revenue for this revenue schedule. You can distribute revenue into a maximum of 250 accounting periods with one revenue schedule.
The sum of the newAmount fields must be equal to the amount field.
items:
$ref: '#/definitions/POSTDistributionItemType'
type: array
revenueEvent:
$ref: '#/definitions/POSTRevenueScheduleByChargeTypeRevenueEvent'
revenueScheduleDate:
description: |
The effective date of the revenue schedule. For example, the revenue schedule date for bookings-based revenue recognition is typically set to the order date or contract date.
The date cannot be in a closed accounting period. The date must be in `yyyy-mm-dd` format.
format: date
type: string
required:
- amount
- revenueScheduleDate
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
example:
amount: '300'
deferredRevenueAccountingCode: Deferred Revenue
deferredRevenueAccountingCodeType: Deferred Revenue
overrideChargeAccountingCodes: 'true'
recognizedRevenueAccountingCode: Subscription Revenue
recognizedRevenueAccountingCodeType: Sales Revenue
referenceId: rs transaction ref
revenueDistributions:
- accountingPeriodName: Jan'2013
newAmount: '100'
- accountingPeriodName: Feb'2013
newAmount: '200'
revenueEvent:
eventType: Revenue Distributed
eventTypeSystemId: '1111111'
notes: Manually distribute revenue by usage
revenueScheduleDate: '2013-01-01'
POSTRevenueScheduleByChargeTypeRevenueEvent:
allOf:
- properties:
eventType:
description: |
Label of the revenue event type. Revenue event type labels can be duplicated. You can configure your revenue event type labels by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Note that `Credit Memo Posted` and `Debit Memo Posted` are only available if you enable the Invoice Settlement feature.
enum:
- Invoice Posted
- Invoice Item Adjustment Created
- Invoice Canceled
- Invoice Item Adjustment Canceled
- Revenue Distributed
- Credit Memo Posted
- Debit Memo Posted
type: string
eventTypeSystemId:
description: 'System ID of the revenue event type. Each eventType has a
unique system ID. You can configure your revenue event type system IDs
by navigating to **Settings > Finance > Configure Revenue Event Types**
in the Zuora UI.
'
type: string
notes:
description: 'Additional information about this record.
'
type: string
required:
- eventTypeSystemId
- eventType
type: object
- $ref: '#/definitions/RevenueEventObjectCustomFields'
description: 'Represents a change to a revenue schedule, such as posting an invoice
or distributing revenue.
'
title: RevenueEvent
POSTRevenueScheduleByDateRangeType:
allOf:
- properties:
distributionType:
description: "How you want to distribute the revenue. \n\n\n* Daily Distribution:\
\ Distributes revenue evenly across each day between the recognitionStart\
\ and recognitionEnd dates.\n* Monthly Distribution (Back Load): Back\
\ loads the revenue so you distribute the monthly amount in the partial\
\ month in the end only.\n* Monthly Distribution (Front Load): Front loads\
\ the revenue so you distribute the monthly amount in the partial month\
\ in the beginning only.\n* Monthly Distribution (Proration by Days):\
\ Splits the revenue amount between the two partial months.\n\n**Note:**\
\ To use any of the Monthly Distribution options, you must have the \"\
Monthly recognition over time\" model enabled in **Settings > Finance\
\ > Manage Revenue Recognition Models** in the Zuora UI.\n"
enum:
- Daily Distribution
- Monthly Distribution (Back Load)
- Monthly Distribution (Front Load)
- Monthly Distribution (Proration by Days)
type: string
notes:
description: 'Additional information about this record.
'
type: string
recognitionEnd:
description: "The end date of a recognition period in `yyyy-mm-dd` format.\
\ \n\nThe maximum difference between the `recognitionStart` and `recognitionEnd`\
\ date fields is equal to 250 multiplied by the length of an accounting\
\ period.\n"
format: date
type: string
recognitionStart:
description: |
The start date of a recognition period in `yyyy-mm-dd` format.
If there is a closed accounting period between the `recognitionStart` and `recognitionEnd` dates, the revenue that would be placed in the closed accounting period is instead placed in the next open accounting period.
format: date
type: string
revenueEvent:
$ref: '#/definitions/POSTRevenueScheduleByDateRangeTypeRevenueEvent'
required:
- recognitionEnd
- recognitionStart
- revenueEvent
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
example:
distributionType: Daily distribution
notes: Manually distribute revenue by usage
recognitionEnd: '2016-12-31'
recognitionStart: 2016-12-1
revenueEvent:
eventType: Revenue Distributed
eventTypeSystemId: RevenueDistributed__z
notes: ''
POSTRevenueScheduleByDateRangeTypeRevenueEvent:
allOf:
- properties:
eventType:
description: |
Label of the revenue event type. Revenue event type labels can be duplicated. You can configure your revenue event type labels by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Note that `Credit Memo Posted` and `Debit Memo Posted` are only available if you enable the Invoice Settlement feature.
enum:
- Invoice Posted
- Invoice Item Adjustment Created
- Invoice Canceled
- Invoice Item Adjustment Canceled
- Revenue Distributed
- Credit Memo Posted
- Debit Memo Posted
type: string
eventTypeSystemId:
description: |
System ID of the revenue event type. Each eventType has a unique system ID. You can configure your revenue event type system IDs by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Required only if there is more than one revenue event type with the same label.
type: string
notes:
description: ''
type: string
type: object
- $ref: '#/definitions/RevenueEventObjectCustomFields'
description: 'Must specify at least one of `eventType` or `eventTypeSystemId`.
'
title: RevenueEvent
POSTRevenueScheduleByTransactionRatablyCMType:
allOf:
- properties:
distributionType:
description: |
How you want to distribute the revenue.
* Daily Distribution: Distributes revenue evenly across each day between the recognitionStart and recognitionEnd dates.
* Monthly Distribution (Back Load): Back loads the revenue so you distribute the monthly amount in the partial month in the end only.
* Monthly Distribution (Front Load): Front loads the revenue so you distribute the monthly amount in the partial month in the beginning only.
* Monthly Distribution (Proration by Days): Splits the revenue amount between the two partial months.
**Note:** To use any of the Monthly Distribution options, you must have the "Monthly recognition over time" model enabled in **Settings > Finance > Manage Revenue Recognition Models** in the Zuora UI.
type: string
notes:
description: 'Additional information about this record.
'
maxLength: 2000
minLength: 0
type: string
recognitionEnd:
description: |
The end date of a recognition period in `yyyy-mm-dd` format.
The maximum difference between the `recognitionStart` and `recognitionEnd` date fields is equal to 250 multiplied by the length of an accounting period.
format: date
type: string
recognitionStart:
description: |
The start date of a recognition period in `yyyy-mm-dd` format.
If there is a closed accounting period between the `recognitionStart` and `recognitionEnd` dates, the revenue that would be placed in the closed accounting period is instead placed in the next open accounting period.
format: date
type: string
revenueEvent:
$ref: '#/definitions/POSTRevenueScheduleByTransactionRatablyTypeRevenueEvent'
required:
- recognitionEnd
- recognitionStart
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
example:
distributionType: daily distribution
notes: notes
recognitionEnd: '2016-12-31'
recognitionStart: '2016-01-01'
revenueEvent:
eventType: Credit Memo Posted
eventTypeSystemId: CreditMemoPosted__z
notes: some notes
POSTRevenueScheduleByTransactionRatablyDMType:
allOf:
- properties:
distributionType:
description: |
How you want to distribute the revenue.
* Daily Distribution: Distributes revenue evenly across each day between the recognitionStart and recognitionEnd dates.
* Monthly Distribution (Back Load): Back loads the revenue so you distribute the monthly amount in the partial month in the end only.
* Monthly Distribution (Front Load): Front loads the revenue so you distribute the monthly amount in the partial month in the beginning only.
* Monthly Distribution (Proration by Days): Splits the revenue amount between the two partial months.
**Note:** To use any of the Monthly Distribution options, you must have the "Monthly recognition over time" model enabled in **Settings > Finance > Manage Revenue Recognition Models** in the Zuora UI.
type: string
notes:
description: 'Additional information about this record.
'
maxLength: 2000
minLength: 0
type: string
recognitionEnd:
description: |
The end date of a recognition period in `yyyy-mm-dd` format.
The maximum difference between the `recognitionStart` and `recognitionEnd` date fields is equal to 250 multiplied by the length of an accounting period.
format: date
type: string
recognitionStart:
description: |
The start date of a recognition period in `yyyy-mm-dd` format.
If there is a closed accounting period between the `recognitionStart` and `recognitionEnd` dates, the revenue that would be placed in the closed accounting period is instead placed in the next open accounting period.
format: date
type: string
revenueEvent:
$ref: '#/definitions/POSTRevenueScheduleByTransactionRatablyTypeRevenueEvent'
required:
- recognitionEnd
- recognitionStart
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
example:
distributionType: daily distribution
notes: notes
recognitionEnd: '2016-12-31'
recognitionStart: '2016-01-01'
revenueEvent:
eventType: Debit Memo Posted
eventTypeSystemId: DebitMemoPosted__z
notes: some notes
POSTRevenueScheduleByTransactionRatablyTypeRevenueEvent:
allOf:
- properties:
eventType:
description: |
The label of the revenue event type. Revenue event type labels can be duplicated. You can configure your revenue event type labels by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Note that `Credit Memo Posted` and `Debit Memo Posted` are only available if you enable the Invoice Settlement feature.
maxLength: 50
minLength: 0
type: string
eventTypeSystemId:
description: |
System ID of the revenue event type. Each eventType has a unique system ID. You can configure your revenue event type system IDs by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Required only if there is more than one revenue event type with the same label.
maxLength: 50
minLength: 0
type: string
notes:
description: 'Additional information about the revenue event.
'
maxLength: 2000
minLength: 0
type: string
type: object
- $ref: '#/definitions/RevenueEventObjectCustomFields'
description: 'Must specify at least one of `eventType` or `eventTypeSystemId`.
'
title: RevenueEvent
POSTRevenueScheduleByTransactionResponseType:
properties:
revenueScheduleNumber:
description: 'Revenue schedule number. The revenue schedule number is always
prefixed with "RS", for example, "RS-00000001".
'
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
POSTRevenueScheduleByTransactionType:
allOf:
- properties:
notes:
description: |
Additional information about this record.
Character Limit: 2,000
type: string
revenueDistributions:
description: |
An array of revenue distributions. Represents how you want to distribute revenue for this revenue schedule. You can distribute revenue into a maximum of 250 accounting periods with one revenue schedule.
The sum of new Amounts must equal the the Charge Amount of the specified Invoice Item.
items:
$ref: '#/definitions/POSTDistributionItemType'
type: array
revenueEvent:
$ref: '#/definitions/POSTRevenueScheduleByTransactionTypeRevenueEvent'
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
example:
revenueDistributions:
- accountingPeriodName: Jan '16
newAmount: '20'
- accountingPeriodName: Open-Ended
newAmount: '30'
revenueEvent:
eventType: Revenue Distributed
eventTypeSystemId: RevenueDistributed__z
notes: My notes
POSTRevenueScheduleByTransactionTypeRevenueEvent:
allOf:
- properties:
eventType:
description: |
Label of the revenue event type. Revenue event type labels can be duplicated. You can configure your revenue event type labels by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Note that `Credit Memo Posted` and `Debit Memo Posted` are only available if you enable the Invoice Settlement feature.
enum:
- Invoice Posted
- Invoice Item Adjustment Created
- Invoice Canceled
- Invoice Item Adjustment Canceled
- Revenue Distributed
- Credit Memo Posted
- Debit Memo Posted
type: string
eventTypeSystemId:
description: |
System ID of the revenue event type. Each eventType has a unique system ID. You can configure your revenue event type system IDs by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Required only if there is more than one revenue event type with the same label.
type: string
notes:
description: 'Additional information about this record.
'
type: string
type: object
- $ref: '#/definitions/RevenueEventObjectCustomFields'
description: |
Represents a change to a revenue schedule, such as posting an invoice or distributing revenue.
You must specify the `eventType` or the `eventTypeSystemID`, or both. If you have configured more than one revenue event type with the same label, you must specify the `eventTypeSystemId`.
title: RevenueEvent
PUTAcceptUserAccessResponseType:
properties:
success:
description: 'Returns `true` if the request is successful.
'
type: boolean
type: object
PUTAllocateManuallyType:
allOf:
- properties:
eventType:
description: |
Label of the revenue event type. Revenue event type labels can be duplicated. You can configure your revenue event type labels by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Note that `Credit Memo Posted` and `Debit Memo Posted` are only available if you enable the Invoice Settlement feature.
enum:
- Invoice Posted
- Invoice Item Adjustment Created
- Invoice Canceled
- Invoice Item Adjustment Canceled
- Revenue Distributed
- Credit Memo Posted
- Debit Memo Posted
type: string
eventTypeSystemId:
description: |
System ID of the revenue event type. Each eventType has a unique system ID. You can configure your revenue event type system IDs by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Cannot be duplicated.
type: string
notes:
description: 'Additional information about this record.
'
type: string
revenueDistributions:
description: 'An array of revenue distributions. Represents how you want
to distribute revenue for this revenue schedule. You can distribute revenue
into a maximum of 250 accounting periods with one revenue schedule.
'
items:
$ref: '#/definitions/POSTDistributionItemType'
type: array
type: object
- $ref: '#/definitions/RevenueEventObjectCustomFields'
example:
eventType: Revenue Distributed
eventTypeSystemId: RevenueDistributed__z
notes: Manually distribute revenue for Phase 1
revenueDistributions:
- accountingPeriodName: Jan'2013
newAmount: '500'
- accountingPeriodName: Feb'2013
newAmount: '600'
PUTDenyUserAccessResponseType:
properties:
success:
description: 'Returns `true` if the request is successful.
'
type: boolean
type: object
PUTDocumentPropertiesType:
example:
customFileName: exampleCreditMemo
properties:
customFileName:
description: 'The custom file name to use to generate new Word or PDF files
for the billing document.
'
type: string
type: object
PUTEntityConnectionsAcceptResponseType:
properties:
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
PUTEntityConnectionsDenyResponseType:
properties:
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
PUTEntityConnectionsDisconnectResponseType:
properties:
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
PUTEventRIDetailType:
example:
revenueItems:
- accountingPeriodName: Oct'2014
- accountingPeriodName: Nov'2014
properties:
revenueItems:
description: |
Revenue items are listed in ascending order by the accounting period start date.
Include at least one custom field.
items:
$ref: '#/definitions/EventRevenueItemType'
type: array
required:
- revenueItems
type: object
PUTPaymentMethodResponseType:
properties:
paymentMethodId:
description: 'ID of the updated payment method.
'
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
PUTPaymentMethodType:
allOf:
- properties:
addressLine1:
description: 'First address line, 255 characters or less.
'
type: string
addressLine2:
description: 'Second address line, 255 characters or less.
'
type: string
cardHolderName:
description: 'The full name as it appears on the card, e.g., "John J Smith",
50 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
'
type: string
country:
description: 'Country; must be a valid country name or abbreviation.
'
type: string
defaultPaymentMethod:
description: 'Specify "true" to make this card the default payment method;
otherwise, omit this parameter to keep the current default payment method.
'
type: boolean
email:
description: 'Card holder''s email address, 80 characters or less.
'
type: string
expirationMonth:
description: 'One or two digit(s) expiration month (1-12).
'
type: integer
expirationYear:
description: 'Four-digit expiration year.
'
type: integer
gatewayOptions:
description: |
The field used to pass gateway-specific parameters and parameter values.
Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
properties:
key:
description: 'The name of a gateway-specific parameter.
'
type: string
value:
description: 'The value of the gateway-specific parameter.
'
type: string
type: object
numConsecutiveFailures:
description: "The number of consecutive failed payments for this payment\
\ method. It is reset to `0` upon successful payment. \n"
format: int32
maximum: 100
minimum: 0
type: integer
phone:
description: 'Phone number, 40 characters or less.
'
type: string
securityCode:
description: |+
The CVV or CVV2 security code for the credit card or debit card. Only required if changing expirationMonth, expirationYear, or cardHolderName. To ensure PCI compliance, this value isn't stored and can't be queried.
type: string
state:
description: 'State; must be a valid state name or 2-character abbreviation.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
type: object
- $ref: '#/definitions/PaymentMethodObjectCustomFields'
example:
cardHolderName: Leo
expirationMonth: 8
expirationYear: 2015
gatewayOptions:
Comments: Updated comments
IPAddress: 172.112.1.1
numConsecutiveFailures: 5
securityCode: '111'
PUTRSBasicInfoType:
allOf:
- properties:
notes:
description: 'Additional information about this record.
'
type: string
referenceId:
description: |
Reference ID is used only in the custom unlimited rule to create a revenue schedule. In this scenario, the revenue schedule is not linked to an invoice item or invoice item adjustment.
Use this field only when the revenue schedule is not linked to an invoice item or invoice item adjustment, such as for revenue schedules based on the Custom - Unlimited recognition model.
maxLength: 100
minLength: 0
type: string
type: object
- $ref: '#/definitions/RevenueScheduleObjectCustomFields'
example:
notes: change recognition term
referenceId: Reference ID
PUTRSTermType:
allOf:
- properties:
distributionType:
description: "How you want to distribute the revenue. \n\n\n* Daily Distribution:\
\ Distributes revenue evenly across each day between the recognitionStart\
\ and recognitionEnd dates.\n* Monthly Distribution (Back Load): Back\
\ loads the revenue so you distribute the monthly amount in the partial\
\ month in the end only.\n* Monthly Distribution (Front Load): Front loads\
\ the revenue so you distribute the monthly amount in the partial month\
\ in the beginning only.\n* Monthly Distribution (Proration by Days):\
\ Splits the revenue amount between the two partial months.\n\n**Note:**\
\ To use any of the Monthly Distribution options, you must have the \"\
Monthly recognition over time\" model enabled in **Settings > Finance\
\ > Manage Revenue Recognition Models** in the Zuora UI.\n"
enum:
- Daily Distribution
- Monthly Distribution (Back Load)
- Monthly Distribution (Front Load)
- Monthly Distribution (Proration by Days)
type: string
eventType:
description: |
Label of the revenue event type. Revenue event type labels can be duplicated. You can configure your revenue event type labels by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Note that `Credit Memo Posted` and `Debit Memo Posted` are only available if you enable the Invoice Settlement feature.
enum:
- Invoice Posted
- Invoice Item Adjustment Created
- Invoice Canceled
- Invoice Item Adjustment Canceled
- Revenue Distributed
- Credit Memo Posted
- Debit Memo Posted
type: string
eventTypeSystemId:
description: 'System ID of the revenue event type. Each eventType has a
unique system ID. You can configure your revenue event type system IDs
by navigating to **Settings > Finance > Configure Revenue Event Types**
in the Zuora UI.
'
type: string
notes:
description: 'Additional information about this record.
'
type: string
recognitionEnd:
description: "The end date of a recognition period in `yyyy-mm-dd` format.\
\ \n\nThe maximum difference between the `recognitionStart` and `recognitionEnd`\
\ date fields is equal to 250 multiplied by the length of an accounting\
\ period.\n"
format: date
type: string
recognitionStart:
description: |
The start date of a recognition period in `yyyy-mm-dd` format.
If there is a closed accounting period between the `recognitionStart` and `recognitionEnd` dates, the revenue that would be placed in the closed accounting period is instead placed in the next open accounting period.
format: date
type: string
required:
- recognitionEnd
- recognitionStart
type: object
- $ref: '#/definitions/RevenueEventObjectCustomFields'
example:
distributionType: Daily distribution
eventType: Revenue Distributed
eventTypeSystemId: RevenueDistributed__z
notes: manual distribute revenue by usage
recognitionEnd: '2015-12-31'
recognitionStart: 2015-12-1
PUTRevenueScheduleResponseType:
properties:
revenueEventNumber:
description: 'The revenue event number created when a revenue event occurs.
'
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
PUTScheduleRIDetailType:
example:
revenueItems:
- accountingPeriodName: Oct'2014
- accountingPeriodName: Nov'2014
properties:
revenueItems:
description: |
Revenue items are listed in ascending order by the accounting period start date.
Include at least one custom field.
items:
$ref: '#/definitions/RevenueScheduleItemType'
type: array
required:
- revenueItems
type: object
PUTSendUserAccessRequestResponseType:
properties:
success:
description: 'Returns `true` if the request is successful.
'
type: boolean
type: object
PUTSendUserAccessRequestType:
example:
targetEntityIds:
- 8a80825555a3c7a10155b46120d058e7
- 8a80825556ff28a4015708b93df82ba7
properties:
targetEntityIds:
description: 'The ID of the entities that the user wants to access.
'
items:
title: Entity IDs
type: string
type: array
required:
- targetEntityIds
type: object
PUTSpecificDateAllocationType:
allOf:
- properties:
amount:
description: 'The revenue schedule amount, which is the sum of all revenue
items. This field cannot be null and must be formatted based on the currency,
such as `JPY 30` or `USD 30.15`. Test out the currency to ensure you are
using the proper formatting otherwise, the response will fail and this
error message is returned: `Allocation amount with wrong decimal places.`
'
format: decimal
type: string
distributeOn:
description: |
The recognition date on which to distribute revenue for milestone-based recognition.
Type: date in `yyyy-mm-dd` format.
format: date
type: string
distributionType:
description: 'How to distribute the revenue for milestone-based recognition. '
enum:
- specific date (delta fixed amount)
- specific date (delta percent total)
- specific date (delta percent undistributed)
type: string
eventType:
description: |
Label of the revenue event type. Revenue event type labels can be duplicated. You can configure your revenue event type labels by navigating to **Settings > Finance > Configure Revenue Event Types** in the Zuora UI.
Note that `Credit Memo Posted` and `Debit Memo Posted` are only available if you enable the Invoice Settlement feature.
enum:
- Invoice Posted
- Invoice Item Adjustment Created
- Invoice Canceled
- Invoice Item Adjustment Canceled
- Revenue Distributed
- Credit Memo Posted
- Debit Memo Posted
type: string
eventTypeSystemId:
description: 'System ID of the revenue event type. Each eventType has a
unique system ID. You can configure your revenue event type system IDs
by navigating to **Settings > Finance > Configure Revenue Event Types**
in the Zuora UI.
'
type: string
notes:
description: 'Additional information about this record.
'
type: string
percentage:
description: |
Percentage of the total recognition amount or total undistributed to distribute.
Required if distributionType is either:
* specific date (delta percent total)
* specific date (delta percent undistributed)
format: decimal
type: string
required:
- distributionType
- distributeOn
type: object
- $ref: '#/definitions/RevenueEventObjectCustomFields'
example:
amount: '1000.00'
distributeOn: '2016-02-03'
distributionType: specific date (delta fixed amount)
eventType: Revenue Distributed
eventTypeSystemId: RevenueDistributed__z
notes: service delivered and accepted by customer
PaymentMethod:
allOf:
- properties:
type:
description: 'Type of payment method. The following types of the payment
method are supported:
'
enum:
- PayPalEC
- PayPalNativeEC
- PayPalAdaptive
- CreditCard
- CreditCardReferenceTransaction
type: string
required:
- type
type: object
- $ref: '#/definitions/CreatePaymentMethodCreditCardReferenceTransaction'
- $ref: '#/definitions/CreatePMPayPalECPayPalNativeEC'
- $ref: '#/definitions/CreatePaymentMethodPayPalAdaptive'
- $ref: '#/definitions/CreatePaymentMethodCreditCard'
- $ref: '#/definitions/CreatePaymentMethodCommon'
- $ref: '#/definitions/PaymentMethodObjectCustomFields'
PaymentMethodObjectCustomFields:
additionalProperties:
description: 'Custom fields of the payment method. 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 a payment method object.
'
title: paymentMethodFieldsCustom
type: object
PaymentObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Payment 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 a Payment object.
'
title: paymentFieldsCustom
type: object
PaymentObjectNSFields:
description: 'Container for Payment fields provided by the [Zuora Connector for
NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
properties:
IntegrationId__NS:
description: 'ID of the corresponding object in NetSuite. Only available if
you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
IntegrationStatus__NS:
description: 'Status of the payment''s synchronization with NetSuite. Only
available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
Origin__NS:
description: 'Origin of the corresponding object in NetSuite. Only available
if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
SyncDate__NS:
description: 'Date when the payment was synchronized with NetSuite. Only available
if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
Transaction__NS:
description: 'Related transaction in NetSuite. Only available if you have
installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
title: paymentFieldsNS
type: object
PriceChangeParams:
properties:
priceChangeOption:
description: |
Specifies how Zuora changes the price of the charge each time the subscription renews.
If the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.
enum:
- NoChange
- SpecificPercentageValue
- UseLatestProductCatalogPricing
type: string
priceIncreasePercentage:
description: 'Specifies the percentage by which the price of the charge should
change each time the subscription renews. Only applicable if the value of
the `priceChangeOption` field is `SpecificPercentageValue`.
'
minimum: -100
type: number
type: object
PricingUpdateForEvergreen:
properties:
chargeModelData:
$ref: '#/definitions/ChargeModelDataOverride'
discount:
$ref: '#/definitions/DiscountPricingUpdate'
recurringFlatFee:
$ref: '#/definitions/RecurringFlatFeePricingUpdate'
recurringPerUnit:
$ref: '#/definitions/RecurringPerUnitPricingUpdate'
recurringTiered:
$ref: '#/definitions/RecurringTieredPricingUpdate'
recurringVolume:
$ref: '#/definitions/RecurringVolumePricingUpdate'
usageFlatFee:
$ref: '#/definitions/UsageFlatFeePricingUpdate'
usageOverage:
$ref: '#/definitions/UsageOveragePricingUpdate'
usagePerUnit:
$ref: '#/definitions/UsagePerUnitPricingUpdate'
usageTiered:
$ref: '#/definitions/UsageTieredPricingUpdate'
usageTieredWithOverage:
$ref: '#/definitions/UsageTieredWithOveragePricingUpdate'
usageVolume:
$ref: '#/definitions/UsageVolumePricingUpdate'
type: object
ProductFeatureObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Product Feature 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 a Product Feature object.
'
title: productFeatureFieldsCustom
type: object
ProvisionEntityResponseType:
properties:
success:
description: Returns `true` if the request is successful.
type: boolean
type: object
ProxyActionamendRequest:
example:
requests:
- Amendments:
- Name: Enable auto-renewal
SubscriptionId: 8ad08ad590a1d7900190a56d87634f5a
Type: TermsAndConditions
ContractEffectiveDate: '2024-07-12'
AutoRenew: true
properties:
requests:
description: 'The value of this field must be an array that contains a single
AmendRequest object. To specify multiple Amendment objects, use the `Amendments`
field of the AmendRequest object.
'
items:
$ref: '#/definitions/AmendRequest'
type: array
type: object
ProxyActionamendResponse:
properties:
results:
description: ''
items:
$ref: '#/definitions/AmendResult'
type: array
type: object
ProxyActionexecuteRequest:
example:
ids:
- 2c93808457d787030157e031d5844c53
synchronous: false
type: InvoiceSplit
properties:
ids:
description: 'The ID of the object. **Values:** a valid InvoiceSplit object
ID.
'
items:
type: string
type: array
synchronous:
description: 'Indicates if the call is synchronous or asynchronous. **Values:**
`false`
'
type: boolean
type:
description: "Specifies the type of executed item. \n"
enum:
- InvoiceSplit
type: string
required:
- type
- ids
- synchronous
type: object
ProxyActiongenerateRequest:
example:
objects:
- AccountId: 2c93808457d787030157e0306be53a75
InvoiceDate: '2016-10-20'
TargetDate: '2016-10-20'
type: Invoice
properties:
objects:
description: ''
items:
$ref: '#/definitions/zObject'
type: array
type:
description: ''
enum:
- Invoice
type: string
required:
- objects
- type
type: object
ProxyActionsubscribeRequest:
example:
subscribes:
- Account:
Name: Amy Lawrence
Currency: USD
BillCycleDay: 1
Batch: Batch1
PaymentTerm: Net 30
BillToContact:
FirstName: Amy
LastName: Lawrence
Country: United States
State: CA
PaymentMethod:
Type: CreditCard
CreditCardType: Visa
CreditCardNumber: '4111111111111111'
CreditCardExpirationYear: 2030
CreditCardExpirationMonth: 12
CreditCardHolderName: Amy Lawrence
SubscriptionData:
Subscription:
ContractEffectiveDate: '2024-07-01'
TermType: TERMED
InitialTerm: 12
RenewalTerm: 12
RatePlanData:
- RatePlan:
ProductRatePlanId: 8ad081dd9096ef9501909b40bb4e74a4
properties:
subscribes:
description: ''
items:
$ref: '#/definitions/SubscribeRequest'
type: array
required:
- subscribes
type: object
ProxyBadRequestResponse:
properties:
Errors:
items:
properties:
Code:
description: ''
type: string
Message:
description: ''
type: string
type: object
type: array
Success:
description: ''
type: boolean
type: object
ProxyCreateAccount:
allOf:
- properties:
AccountNumber:
description: |
Unique account number assigned to the account. **Character limit**: 50 **Values**: one of the following:
- null to auto-generate
- a string of 50 characters or fewer that doesn't begin with the default account number prefix
type: string
AdditionalEmailAddresses:
description: 'List of additional email addresses to receive email notifications.
**Character limit**: 120 **Values**: comma-separated list of email addresses '
type: string
AllowInvoiceEdit:
description: " Indicates if associated invoices can be edited.\n**Character\
\ limit**: 5 **Values**: `true`, `false` (default if left null) "
type: boolean
AutoPay:
description: " Indicates if future payments are automatically collected\
\ when they're due during a Payment Run.\n**Character limit**: 5 **Values**:\
\ `true`, `false` (default) "
type: boolean
Batch:
description: |
Organizes your customer accounts into groups to optimize\
\ your billing and payment operations. Required if use the Subscribe call.\n\
**Character limit**: 20 **Values**:any system-defined batch (`Batch1`\
\ - `Batch50 `or by name).
**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
type: string
BcdSettingOption:
description: 'Billing cycle day setting option. **Character limit**: 9 **Values**:
`AutoSet`, `ManualSet` '
type: string
BillCycleDay:
description: 'Billing cycle day (BCD) on which bill runs generate invoices
for the account. **Character limit**: 2 **Values**: any activated system-defined
bill cycle day (`1` - `31`) '
format: int32
type: integer
BillToId:
description: 'ID of the person to bill for the account. This field is only
required if the `Status` field is set to `Active`. **Character limit**:
32 **Values**: a valid contact ID for the account '
type: string
CrmId:
description: 'CRM account ID for the account. A CRM is a customer relationship
management system, such as Salesforce.com. **Character limit**: 100 **Values**:
a string of 100 characters or fewer '
type: string
Currency:
description: ' Currency that the customer is billed in. '
type: string
CustomerServiceRepName:
description: 'Name of the account''s customer service representative, if
applicable. **Character limit**: 50 **Values**: a string of 50 characters
or fewer '
type: string
DefaultPaymentMethodId:
description: 'ID of the default payment method for the account. This field
is only required if the `AutoPay` field is set to `true`. For a specified
credit card payment method, it is recommended that [the support for stored
credential transactions](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Stored_credential_transactions)
for this payment method is already enabled. **Character limit**: 32 **Values**:
a valid ID for an existing payment method '
type: string
InvoiceDeliveryPrefsEmail:
description: 'Indicates if the customer wants to receive invoices through
email. **Character limit**: 5 **Values**: `true`, `false` (default if
left null) '
type: boolean
InvoiceDeliveryPrefsPrint:
description: 'Indicates if the customer wants to receive printed invoices,
such as through postal mail. **Character limit**: 5 **Values**: `true`,
`false` (default if left null) '
type: boolean
InvoiceTemplateId:
description: 'The ID of the invoice template. Each customer account can
use a specific invoice template for invoice generation. **Character limit**:
32 **Values**: a valid template ID configured in Zuora Billing Settings '
type: string
Name:
description: 'Name of the account as displayed in the Zuora UI. **Character
limit**: 255 **Values**: a string of 255 characters or fewer '
type: string
Notes:
description: ' Comments about the account. **Character limit**: 65,535 **Values**:
a string of 65,535 characters '
type: string
ParentId:
description: 'Identifier of the parent customer account for this Account
object. Use this field if you have customer hierarchy enabled. **Character
limit**: 32 **Values**: a valid account ID '
type: string
PartnerAccount:
type: boolean
default: false
description: |
Whether the customer account is a partner, distributor, or reseller.
You can set this field to `true` if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests.
After this field is set to `true`, the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments.
**Note**:
- This field is available only if you have the Reseller Account feature enabled.
- This field is only available if you set the `X-Zuora-WSDL-Version` request header to `131` or later.
PaymentGateway:
description: |
Gateway used for processing electronic payments and refunds. This field is only required if there is no default payment gateway is defined in the tenant. **Character limit**: 40 **Values**: one of the following:
- a valid configured gateway name
- Null to inherit the default value set in Zuora Payment Settings
type: string
PaymentTerm:
description: 'Indicates when the customer pays for subscriptions. **Character
limit**: 100 **Values**: a valid, active payment term defined in the web-based
UI administrative settings '
type: string
PurchaseOrderNumber:
description: 'The number of the purchase order associated with this account.
Purchase order information generally comes from customers. **Character
limit**: 100 **Values**: a string of 100 characters or fewer '
type: string
SalesRepName:
description: 'The name of the sales representative associated with this
account, if applicable. **Character limit**: 50 **Values**: a string of
50 characters or fewer '
type: string
SoldToId:
description: 'ID of the person who bought the subscription associated with
the account. This field is only required if the `Status` field is set
to `Active`. **Character limit**: 32 **Values**: a valid contact ID for
the account '
type: string
Status:
description: 'Status of the account in the system.
'
enum:
- Draft
- Active
- Canceled
maxLength: 8
type: string
TaxCompanyCode:
description: " Unique code that identifies a company account in Avalara.\
\ Use this field to calculate taxes based on origin and sold-to addresses\
\ in Avalara.\nThis 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**Character limit**: 50 **Values**: a valid company code "
type: string
TaxExemptCertificateID:
description: 'ID of your customer''s tax exemption certificate. **Character
limit**: 32 **Values**: a string of 32 characters or fewer '
type: string
TaxExemptCertificateType:
description: 'Type of the tax exemption certificate that your customer holds. **Character
limit**: 32 **Values**: a string of 32 characters or fewer '
type: string
TaxExemptDescription:
description: 'Description of the tax exemption certificate that your customer
holds. **Character limit**: 500 **Values**: a string of 500 characters
or fewer '
type: string
TaxExemptEffectiveDate:
description: 'Date when the the customer''s tax exemption starts. **Character
limit**: 29 **Version notes**: requires Zuora Tax '
format: date
type: string
TaxExemptExpirationDate:
description: 'Date when the customer''s tax exemption certificate expires **Character
limit**: 29 **Version notes**: requires Zuora Tax '
format: date
type: string
TaxExemptIssuingJurisdiction:
description: 'Indicates the jurisdiction in which the customer''s tax exemption
certificate was issued. **Character limit**: 32 **Values**: a string of
32 characters or fewer '
type: string
TaxExemptStatus:
description: |2
Status of the account's tax exemption. This field is only required if you use Zuora Tax. This field is not available if you do not use Zuora Tax.
**Character limit**: 19 **Values**: one of the following:
- `Yes`
- `No`
- `PendingVerification`
type: string
VATId:
description: " EU Value Added Tax ID.\nThis 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**Character limit**:\
\ 25 **Values**: a valid Value Added Tax ID "
type: string
communicationProfileId:
description: 'Associates the account with a specified communication profile.
**Character limit**: 32 **Values**: a valid communication profile ID '
type: string
required:
- BillCycleDay
- Currency
- Name
- Status
type: object
- $ref: '#/definitions/AccountObjectNSFields'
- $ref: '#/definitions/AccountObjectCustomFields'
example:
Name: Amy Lawrence
Currency: USD
BillCycleDay: 1
Status: Draft
ProxyCreateCreditBalanceAdjustment:
allOf:
- properties:
AccountingCode:
description: |
An active accounting code in your Zuora [Chart of Accounts](https://knowledgecenter.zuora.com/CB_Billing/W_Billing_and_Payments_Settings/V_Configure_Accounting_Codes/D_Set_Up_Chart_of_Accounts).
The [accounting code](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/A_Product_Catalog_Concepts/Accounting_Codes) for the credit balance adjustment. Typically, an accounting code for a credit balance adjustment maps to a bank account in your accounting system.
maxLength: 100
type: string
AdjustmentDate:
description: |
The date when the credit balance adjustment is applied.
With the Future Dated Credit Balance Adjustment feature enabled, you can use this field to specify when the credit balance adjustment is applied. If not specified, the value defaults to the latter date of the date when the API operation is called and the invoice date.
With the Future Dated Credit Balance Adjustment feature disabled, if no value is specified for this field, the value defaults to the date when the API operation is called. If you specify a value for this field, the value must be the date when the API operation is called.
format: date
maxLength: 29
minLength: 0
type: string
Amount:
description: 'The amount of the adjustment.
'
format: double
type: number
Comment:
description: 'Your comments about the credit balance adjustment.
'
maxLength: 255
type: string
ReasonCode:
description: 'A code identifying the reason for the transaction. Must be
an existing [reason code](https://knowledgecenter.zuora.com/CB_Billing/K_Payment_Operations/Reason_Codes_for_Payment_Operations)
or empty. If you do not specify a value, Zuora uses the default reason
code.
'
maxLength: 32
type: string
ReferenceId:
description: 'The ID of the payment that the credit balance adjustment is
for.
'
maxLength: 100
type: string
SourceTransactionId:
description: |
The ID of the object that the credit balance adjustment is applied to. You must specify a value for either the `SourceTransactionId` field or the `SourceTransactionNumber` field.
The value of this field must be an invoice ID.
maxLength: 32
type: string
SourceTransactionNumber:
description: |
The number of the object that the credit balance adjustment is applied to. You must specify a value for either the `SourceTransactionId` field or the `SourceTransactionNumber` field.
The value of this field must be an invoice number.
maxLength: 50
type: string
Type:
description: 'Whether the credit balance adjustment increases or decrease
the amount of the credit balance.
'
enum:
- Decrease
- Increase
type: string
required:
- Amount
- Type
type: object
- $ref: '#/definitions/CreditBalanceAdjustmentObjectNSFields'
- $ref: '#/definitions/CreditBalanceAdjustmentObjectCustomFields'
example:
Amount: 60
Comment: Transfer $60.00 from a negative invoice to the account balance
SourceTransactionNumber: INV00000420
Type: Increase
ProxyCreateExport:
example:
Query: select AccountNumber, BillCycleDay from Account
Format: csv
properties:
ConvertToCurrencies:
description: " The currencies that you want to convert transaction amounts\
\ into. You can specify any number of currencies. Specify the currencies\
\ using their Foreign Currency Conversion enabled to use this field.\n**Character\
\ limit**: **Values**: a list of valid currency codes "
type: string
Encrypted:
description: " Exports a secure version of encrypted data source fields. such\
\ as the AchAccountNumber field of the PaymentMethod object and the DefaultPaymentMethod\
\ data souce objects.\n**Character limit**: 5 **Values:** true, false "
type: boolean
FileId:
description: " The ID of the file generated by an export query. This file\
\ is automatically generated when an Export object is created. Use this\
\ file ID with [Get files](https://developer.zuora.com/api-references/api/operation/GET_Files)\
\ to download the export file.\n**Character limit**: 32 **Values**: automatically\
\ generated "
type: string
Format:
description: " The format that you want the export file to use.\n**Character\
\ limit**: 5 "
enum:
- csv
- html
- Excel
type: string
Name:
description: " The name of the export.\n**Character limit**: 255 **Values**:\
\ a string of 255 characters or fewer "
type: string
Query:
description: '[Export ZOQL](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL)
query.
'
type: string
Size:
description: " The number of records or rows exported. This field value is\
\ null until the export status is Completed.\n**Character limit**: **Values**:\
\ automatically generated "
format: int32
type: integer
Status:
description: |2
The status of the export. Type: string (enum) **Character limit**: 10 **Values**: automatically generated to be one of the following values:
- Pending
- Processing
- Completed
- Canceled
- Failed
type: string
StatusReason:
description: " The reason for the given status. Use this information to help\
\ ascertain why an export failed.\n**Character limi**t: 255 **Values**:\
\ automatically generated "
type: string
Zip:
description: " Indicates if you want the resulting export file to be compressed\
\ into a zip file.\n**Character limit**: **Values**: true, false (default) "
type: boolean
required:
- Format
- Query
type: object
ProxyCreateFeature:
allOf:
- properties:
Description:
description: 'Description of the feature.
'
maxLength: 1000
type: string
FeatureCode:
description: 'Unique code of the feature.
'
maxLength: 255
type: string
Name:
description: 'Name of the feature.
'
maxLength: 255
type: string
Status:
default: Active
description: 'Status of the feature.
'
enum:
- Active
- Inactive
type: string
required:
- Name
- FeatureCode
type: object
- $ref: '#/definitions/FeatureObjectCustomFields'
example:
Description: An experimental feature for early adopters
FeatureApprover__c: sally@example.com
FeatureCode: F017
Name: Experimental Feature
Status: Active
ProxyCreateInvoiceAdjustment:
allOf:
- properties:
AccountId:
description: " The ID of the account that owns the invoice.\n**Character\
\ limit**: 32 **Values**: inherited from Account.ID for the invoice owner "
type: string
AccountingCode:
description: 'The accounting code for the invoice adjustment. '
type: string
AdjustmentDate:
description: " The date when the invoice adjustment is applied. This date\
\ must be the same as the invoice's date or later.\n**Character limit**:\
\ 29 **Values**: Leave null to automatically generate the current date "
format: date
type: string
AdjustmentNumber:
description: " A unique string to identify an individual invoice adjustment.\n\
**Character limit**: 255 **Values**: automatically generated "
type: string
Amount:
description: " The amount of the invoice adjustment.\n**Character limit**:\
\ 16 **Values**: a valid currency amount "
format: double
type: number
Comments:
description: " Use this field to record comments about the invoice adjustment.\n\
**Character limit**: 255 **Values**: a string of 255 characters or fewer "
type: string
CustomerName:
description: " The name of the account that owns the associated invoice.\n\
**Character limit**: 50 **Values**: inherited from Account.Name "
type: string
CustomerNumber:
description: " The unique account number of the customer's account.\n**Character\
\ limit**: 70 **Values**: inherited from Account.AccountNumber "
type: string
ImpactAmount:
description: " The amount that changes the balance of the associated invoice.\n\
**Character limit**: 16 **Values**: automatically calculated "
format: double
type: number
InvoiceId:
description: " The ID of the invoice associated with the adjustment. This\
\ field is only required if you don't specify a value for the `InvoiceNumber`\
\ field.\n**Character limit**: 32 **Values**: a valid invoice ID "
type: string
InvoiceNumber:
description: " The unique identification number for the associated invoice.\
\ This field is only required if you don't specify a value for the `InvoiceId`\
\ field.\n**Character limit**: 32 **Values**: a valid invoice number "
type: string
ReasonCode:
description: " A code identifying the reason for the transaction. Must be\
\ an existing reason code or empty. If you do not specify a value, Zuora\
\ uses the default reason code.\n**Character limit**: 32 **V****alues**:\
\ a valid reason code "
type: string
ReferenceId:
description: " A code to reference an object external to Zuora. For example,\
\ you can use this field to reference a case number in an external system.\n\
**Character limit**: 100 **Values**: a string of 100 characters or fewer "
type: string
Status:
description: " The status of the invoice adjustment. This field is only\
\ required in the Query call, but is automatically generated in other\
\ calls.\n**Character limit**: 9 **Values**: `Canceled`, `Processed` "
type: string
Type:
description: " Indicates whether the adjustment credits or debits the invoice\
\ amount.\n**Character limit**: 6 **Values**: `Credit`, `Charge` "
type: string
required:
- Amount
- Type
type: object
- $ref: '#/definitions/InvoiceAdjustmentObjectCustomFields'
example:
AccountingCode: Accounts Receivable
AdjustmentDate: '2016-10-20'
Amount: 1.2
Comments: this is comments
InvoiceId: 2c93808457d787030157e030d10f3f64
InvoiceNumber: INV00000001
ReferenceId: refid-1476935078657
Type: Credit
ProxyCreateInvoiceItemAdjustment:
allOf:
- properties:
AccountingCode:
description: " The accounting code for the invoice item. Accounting codes\
\ group transactions that contain similar accounting attributes.\n**Character\
\ limit**: 100 **Values**: inherited from `InvoiceItem.AccountingCode` "
type: string
AdjustmentDate:
description: " The date when the invoice item adjustment is applied, in\
\ `yyyy-mm-dd` format. This date must be the same as the invoice's date\
\ or later.\n**Character limit**: 29 "
format: date
type: string
AdjustmentNumber:
description: " A unique string to identify an individual invoice item adjustment.\n\
**Character limit**: 255 **Values**: automatically generated "
type: string
Amount:
description: ' The amount of the invoice item adjustment. The value of Amount
must be positive. Use the required parameter Type to either credit or
charge (debit) this amount on the invoice. **Character limit**: 16 **Values**:
a valid currency amount '
format: double
type: number
Comment:
description: " Use this field to record comments about the invoice item\
\ adjustment.\n**Character limit**: 255 **Values**: a string of 255 characters\
\ or fewer "
type: string
CreatedById:
description: " The user ID of the person who created the invoice item.\n\
**Character limit**: 32 **Values**: automatically generated "
type: string
DeferredRevenueAccount:
description: |2-
Records the deferred accounting code in the finance system. This field is in Limited Availability. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). **Character limit**: 100
**Version notes**: WSDL 63.0+
**Values**: If this field is not passed in, a value from InvoiceItem will be used.
type: string
ExcludeItemBillingFromRevenueAccounting:
default: false
description: "The flag to exclude Order Line Item related invoice items,\
\ invoice item adjustments, credit memo items, and debit memo items that\
\ are generate for the rate plan charge from revenue accounting. Set this\
\ field to `true` to exclude the billing item from the revenue accounting.\
\ \n \n**Character limit**: 100 \n\n**Version notes**: WSDL 117.0+\n\
\n**Values**: a boolean value\n\n**Note**: This field is only available\
\ if you have the Billing - Revenue Integration feature enabled.\n"
type: boolean
InvoiceId:
description: " The ID of the invoice associated with the adjustment. The\
\ adjustment invoice item is in this invoice. This field is optional if\
\ you specify a value for the `InvoiceNumber` field.\n**Character limit**:\
\ 3 **Values**: a valid invoice ID "
type: string
InvoiceNumber:
description: " The unique identification number for the invoice that contains\
\ the invoice item. This field is optional if you specify a value for\
\ the `InvoiceId` field.\n**Character limit**: 32 **Values**: a valid\
\ invoice number "
type: string
ReasonCode:
description: " A code identifying the reason for the transaction. Must be\
\ an existing reason code or empty. If you do not specify a value, Zuora\
\ uses the default reason code.\n**Character limit**: 32 **Values**: a\
\ valid reason code "
type: string
RecognizedRevenueAccount:
description: |2-
Records the recognized accounting code in the finance system. This field is in Limited Availability. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). **Character limit**: 100
**Version notes**: WSDL 63.0+
**Values**: If this field is not passed in, a value from InvoiceItem will be used.
type: string
ReferenceId:
description: " A code to reference an object external to Zuora. For example,\
\ you can use this field to reference a case number in an external system.\n\
**Character limit**: 60 **Values**: a string of 60 characters or fewer "
type: string
SourceId:
description: " The ID of the item specified in the SourceType field.\n**Character\
\ limit**: 32 **Values**: a valid invoice item ID or taxation item ID "
type: string
SourceType:
description: " The type of adjustment.\n**Character limit**: 13 **Values**:\
\ InvoiceDetail, Tax "
type: string
Type:
description: Indicates whether the adjustment credits or debits the invoice
item amount.
enum:
- Credit
- Charge
type: string
required:
- AdjustmentDate
- Amount
- InvoiceId
- InvoiceNumber
- SourceId
- SourceType
- Type
type: object
- $ref: '#/definitions/InvoiceItemAdjustmentObjectNSFields'
- $ref: '#/definitions/InvoiceItemAdjustmentObjectCustomFields'
example:
AdjustmentDate: '2021-02-05'
Amount: 1
Comments: this is comments
InvoiceNumber: INV00046254
SourceId: 8a9092747e5b9fd0017e5c9a9ece127f
SourceType: InvoiceDetail
Type: Credit
ProxyCreateInvoicePayment:
example:
Amount: 10
InvoiceId: 2c93808457d787030157e02deadb1b6d
PaymentId: 2c93808457d787030157e02de5fc1b57
properties:
Amount:
description: " The amount of the payment.\n**Character limit**: 16 **Values**:\
\ a valid currency amount "
format: double
type: number
InvoiceId:
description: " The unique ID of the invoice associated with this invoice payment.\n\
**Character limit**: 32 **Values**: a valid invoice ID "
type: string
PaymentId:
description: " The unique ID of the payment associated with this invoice payment.\n\
**Character limit**: 32 **V****alues**: a valid payment ID "
type: string
required:
- Amount
- InvoiceId
- PaymentId
type: object
ProxyCreateOrModifyResponse:
properties:
Id:
description: ''
type: string
Success:
description: ''
type: boolean
type: object
ProxyCreatePayment:
allOf:
- properties:
AccountId:
description: 'The unique account ID for the customer that the payment is
for.
'
maxLength: 32
minLength: 0
type: string
AccountingCode:
description: 'The accounting code for the payment. Accounting codes group
transactions that contain similar accounting attributes.
'
maxLength: 100
minLength: 0
type: string
Amount:
description: |
The amount of the payment.
If Invoice Settlement is enabled, this field is required.
format: double
maxLength: 16
minLength: 0
type: number
AppliedCreditBalanceAmount:
description: |
If you have the Invoice Settlement feature disabled, the value of this field is the amount of the payment to apply to a credit balance. This field is only required if the `AppliedInvoiceAmount` field value is null.
If you have the Invoice Settlement feature enabled, the value of this field is created as the unapplied amount.
format: double
maxLength: 16
minLength: 0
type: number
AppliedInvoiceAmount:
description: 'The amount of the payment to apply to an invoice. This field
is only required if either the `InvoiceId` or `InvoiceNumber` field is
not null.
'
format: decimal
maxLength: 16
minLength: 0
type: number
AuthTransactionId:
description: |
The authorization transaction ID from the payment gateway. Use this field for electronic payments, such as credit cards.
The following payment gateways support this field:
- Adyen Integration v2.0
- CyberSource 1.28
- CyberSource 1.97
- CyberSource 2.0
- Chase Paymentech Orbital
- Ingenico ePayments
- SlimPay
- Verifi Global Payment Gateway
- WePay Payment Gateway Integration
maxLength: 50
minLength: 0
type: string
Comment:
description: 'Additional information related to the payment.
'
maxLength: 255
minLength: 0
type: string
EffectiveDate:
description: |
The date when the payment takes effect, in `yyyy-mm-dd` format.
**Note:**
- This field is required for only electronic payments. It's an optional field for external payments.
- When specified, this field must be set to the date of today.
format: date
maxLength: 29
minLength: 0
type: string
Gateway:
description: 'The name of the gateway instance that processes the payment.
When creating a payment, the value of this field must be a valid gateway
instance name, and this gateway must support the specific payment method.
If no value is specified, the default gateway on the Account will be used.
'
type: string
GatewayOptionData:
description: |
A field used to pass gateway options. Zuora allows you to pass in special gateway-specific parameters for payments through the [gateway integrations that support gateway options](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0#Gateway_Options).
For each of these special parameters, you supply the name-value pair and Zuora passes it to the gateway. This allows you to add functionality that's supported by a specific gateway but currently not supported by Zuora.
Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
properties:
GatewayOption:
description: ''
items:
$ref: '#/definitions/GatewayOption'
maxItems: 200
minItems: 0
type: array
required:
- GatewayOption
type: object
GatewayOrderId:
description: |
A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.
Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems.
maxLength: 70
minLength: 0
type: string
GatewayResponse:
description: 'The message returned from the payment gateway for the payment.
This message is gateway-dependent.
'
maxLength: 500
minLength: 0
type: string
GatewayResponseCode:
description: 'The code returned from the payment gateway for the payment.
This code is gateway-dependent.
'
maxLength: 20
minLength: 0
type: string
GatewayState:
description: 'The status of the payment in the gateway; use for reconciliation.
'
enum:
- MarkedForSubmission
- Submitted
- Settled
- NotSubmitted
- FailedToSettle
type: string
InvoiceId:
description: 'The ID of the invoice that the payment is applied to. When
applying a payment to a single invoice, this field is only required if
the `InvoiceNumber` field is null.
'
maxLength: 32
minLength: 0
type: string
InvoiceNumber:
description: 'The unique identification number for the invoice that the
payment is applied to. When applying a payment to a single invoice, this
field is only required if the `InvoiceId` field is null.
'
maxLength: 32
minLength: 0
type: string
InvoicePaymentData:
description: 'Container for the invoice payment data. This field is only
required if you apply a payment to multiple invoices.
'
properties:
InvoicePayment:
description: ''
items:
$ref: '#/definitions/InvoicePayment'
maxItems: 200
minItems: 0
type: array
required:
- InvoicePayment
title: InvoicePaymentData
type: object
PaymentMethodId:
description: "The ID of the payment method used for the payment.\n"
maxLength: 32
minLength: 0
type: string
ReferenceId:
description: 'The transaction ID returned by the payment gateway. Use this
field to reconcile payments between your gateway and Zuora Payments.
'
maxLength: 100
minLength: 0
type: string
SoftDescriptor:
description: "A payment gateway-specific field that maps to Zuora for the\
\ gateways, Orbital, Vantiv and Verifi. \n\nZuora passes this field to\
\ Verifi directly without verification. In general, this field will be\
\ defaulted by the gateway. For Orbital, this field contains two fields\
\ separated by an asterisk, `SDMerchantName` and `SDProductionInfo`. For\
\ more information, contact your payment gateway.\n"
maxLength: 35
minLength: 0
type: string
SoftDescriptorPhone:
description: |
A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.
Verifi and Orbital determine how to format this string. For more information, contact your payment gateway.
maxLength: 20
minLength: 0
type: string
Status:
description: 'The status of the payment in Zuora. The only available value
is `Processed`.
'
enum:
- Processed
type: string
Type:
description: 'The type of the payment, whether the payment is external or
electronic.
'
enum:
- External
- Electronic
type: string
required:
- AccountId
- PaymentMethodId
- Status
- Type
type: object
- $ref: '#/definitions/PaymentObjectNSFields'
- $ref: '#/definitions/PaymentObjectCustomFields'
example:
AccountId: 8ad09be48db5aba7018db604776d4854
Type: Electronic
PaymentMethodId: 8ad084db90a5e73b0190c02783f552fa
EffectiveDate: '2016-10-20'
Status: Processed
InvoiceId: 8ad087d2909fae960190a1209e216cf2
Amount: 105.32
AppliedCreditBalanceAmount: 0
AppliedInvoiceAmount: 105.32
ProxyCreatePaymentMethod:
allOf:
- properties:
AccountId:
description: |-
The ID of the customer account associated with this payment method.
To create an orphan payment method that is not associated with any customer account, you do not need to specify this field during creation. However, you must associate the orphan payment method with a customer account within 10 days. Otherwise, this orphan payment method will be deleted.
type: string
AchAbaCode:
description: " The nine-digit routing number or ABA number used by banks.\
\ This field is only required if the `Type` field is set to `ACH`.\n\n\
**Character limit**: 9 **Values**: a string of 9 characters or fewer "
type: string
AchAccountName:
description: " The name of the account holder, which can be either a person\
\ or a company. This field is only required if the `Type` field is set\
\ to `ACH`.\n\n**Character limit**: 70 **Values**: a string of 70 characters\
\ or fewer "
type: string
AchAccountNumber:
description: "The bank account number associated with the ACH payment. This\
\ field is only required if the `Type` field is set to `ACH`.\n**Character\
\ limit**: 30 **Values**: a string of 30 numeric characters or fewer "
type: string
AchAccountType:
description: |2
The type of bank account associated with the ACH payment. This field is only required if the `Type` field is set to `ACH`.
When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably.
**Character limit**: 16 **Values**:
- `BusinessChecking`
- `BusinessSaving`
- `Checking`
- `Saving`
type: string
AchAddress1:
description: ' Line 1 for the ACH address. This field is required for creating
a payment method for the Vantiv payment gateway. **Character limit**:
255 **Values**: an address '
type: string
AchAddress2:
description: ' Line 2 for the ACH address. This field is required for creating
a payment method for the Vantiv payment gateway. **Character limit**:
255 **Values**: an address '
type: string
AchBankName:
description: " The name of the bank where the ACH payment account is held.\
\ This field is only required if the `Type` field is set to `ACH`.\nWhen\
\ creating an ACH payment method on Adyen, this field is required by Zuora\
\ but it is not required by Adyen. To create the ACH payment method successfully,\
\ specify a real value for this field if you can. If it is not possible\
\ to get the real value for it, specify a dummy value.\n**Character limit**:\
\ 70 **Values**: a string of 70 characters or fewer "
type: string
AchCity:
description: "The city of the ACH address. Use this field for ACH payment\
\ methods. **Note**: This field is only specific to the NMI payment gateway.\n\
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.\n**Character\
\ limit**: 40 **Values**: a string of 40 characters or fewer "
type: string
AchCountry:
description: "The country of the ACH address. See [Country Names and Their\
\ ISO Standard 2- and 3-Digit Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/A_Country_Names_and_Their_ISO_Codes)\
\ for the list of supported country names. Use this field for ACH methods.\
\ **Note**: This field is only specific to the NMI payment gateway.\n\
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.\n**Character\
\ limit**: 40 **Values**: a supported country name "
type: string
AchPostalCode:
description: "The billing address's zip code. This field is required only\
\ when you define an ACH payment method. **Note**: This field is only\
\ specific to the NMI payment gateway.\n**Character limit**: 20 **Values**:\
\ a string of 20 characters or fewer "
type: string
AchState:
description: "The billing address's state. Use this field is if the `ACHCountry`\
\ value is either `Canada` or the `US`. State names must be spelled in\
\ full. For more information, see the list of [supported state names](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/B_State_Names_and_2-Digit_Codes).\
\ This field is required only when you define an ACH payment method. **Note**:\
\ This field is only specific to the NMI payment gateway.\n**Character\
\ limit**: 50 **Values**: a valid state name "
type: string
BankBranchCode:
description: |
The branch code of the bank used for direct debit. This field is required for the following bank transfer payment methods:
- Sweden Direct Debit (`Autogiro`)
- Direct Debit NZ (`DirectDebitNZ`)
- Pre-Authorized Debit (`PAD`)
**Character limit**: 10
type: string
BankCheckDigit:
description: 'The check digit in the international bank account number,
which confirms the validity of the account. Use this field for direct
debit payment methods. **Character limit**: 4 **Values**: a string of
4 characters or fewer '
type: string
BankCode:
description: |
The sort code or number that identifies the bank. This is also known as the sort code. This field is required for the following bank transfer payment methods:
- Direct Debit UK (`Bacs`)
- Denmark Direct Debit (`Betalingsservice`)
- Direct Debit NZ (`DirectDebitNZ`)
- Pre-Authorized Debit (`PAD`)
type: string
BankTransferAccountName:
description: "The name on the customer's bank account. This field is required\
\ if the\_`Type`\_field is set to\_`BankTransfer`.\n\n**Character limit**:\
\ 60\n\n**Values**: a string of 60 characters or fewer\n"
type: string
BankTransferAccountNumber:
description: "The number of the customer's bank account. This field is required\
\ if the\_`Type`\_field is set to\_`BankTransfer`.\n\n**Character limit**:\
\ 30\n\n**Values**: a string of 30 characters or fewer\n"
type: string
BankTransferAccountNumberMask:
description: |2
This is a masked displayable version of the ACH account number, used for security purposes. For example: `XXXXXXXXX54321`.
**Character limit**: 32
**Values**: automatically generated
type: string
BankTransferType:
description: "The type of direct debit transfer. The value of this field\
\ is dependent on the country of the user. This field is only required\
\ if the `Type` field is set to `BankTransfer`.\n\n **Values**: \n\n \
\ - `SEPA`\n\n - `DirectEntryAU` (Australia)\n\n - `DirectDebitUK` (UK)\n\
\n - `Autogiro` (Sweden)\n\n - `Betalingsservice` (Denmark)\n\n - `DirectDebitNZ`\
\ (New Zealand)\n \n - `PAD` (Canada)\n \n - `AutomatischIncasso`\
\ (Netherlands)\n\n - `LastschriftDE` (Germany)\n\n - `LastschriftAT`\
\ (Austria)\n\n - `DemandeDePrelevement` (France)\n\n - `Domicil` (Belgium)\n\
\n - `LastschriftCH` (Switzerland)\n\n - `RID` (Italy)\n\n - `OrdenDeDomiciliacion`\
\ (Spain)\n"
maxLength: 20
type: string
BusinessIdentificationCode:
description: " The business identification code for Swiss direct payment\
\ methods that use the Global Collect payment gateway. Use this field\
\ only for direct debit payments in Switzerland with Global Collect.\n\
**Character limit**: 11 **Values**: a string of 11 characters or fewer "
type: string
City:
description: " The city of the customer's address. Use this field for direct\
\ debit payment methods.\nIt 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.\n**Character limit**:80 **Values**: a string of\
\ 80 characters or fewer "
type: string
CompanyName:
description: |
The name of the company.
Zuora does not recommend that you use this field.
maxLength: 80
type: string
Country:
description: |
The two-letter country code of the customer's address. This field is required if the `Type` field is set to `BankTransfer`, and the `BankTransferType` field is set to any of the following values:
- `Autogiro`
- `Betalingsservice`
- `DirectDebitUK`
- `DirectEntryAU`
- `DirectDebitNZ`
- `PAD`
It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.
type: string
CreditCardAddress1:
description: " The first line of the card holder's address, which is often\
\ a street address or business name. Use this field for credit card and\
\ direct debit payment methods.\n**Character limit**: 255 **Values**:\
\ a string of 255 characters or fewer "
type: string
CreditCardAddress2:
description: " The second line of the card holder's address. Use this field\
\ for credit card and direct debit payment methods.\n**Character limit**:\
\ 255 **Values**: a string of 255 characters or fewer "
type: string
CreditCardCity:
description: " The city of the card holder's address. Use this field for\
\ credit card and direct debit payment methods.\nIt 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. **Character limit**:\
\ 40 **Values**: a string of 40 characters or fewer "
type: string
CreditCardCountry:
description: " The country of the card holder's address.\nIt is recommended\
\ to provide the city and country information when creating a payment\
\ method. The information will be used to process payments. If the information\
\ is not provided during payment method creation, the city and country\
\ data will be missing during payment processing. "
type: string
CreditCardExpirationMonth:
description: " The expiration month of the credit card or debit card. This\
\ field is required if the `Type` field is set to `CreditCard` or `DebitCard`.\n\
**Character limit**: 2 **Values**: a two-digit number, 01 - 12 "
format: int32
type: integer
CreditCardExpirationYear:
description: " The expiration month of the credit card or debit card. This\
\ field is required if the `Type` field is set to `CreditCard` or `DebitCard`.\n\
**Character limit**: 4 **Values**: a four-digit number "
format: int32
type: integer
CreditCardHolderName:
description: " The full name of the card holder. This field is only required\
\ if the `Type` field is set to `CreditCard` or `DebitCard`.\n\n**Character\
\ limit**: 50 **Values**: a string of 50 characters or fewer "
type: string
CreditCardNumber:
description: 'Credit card number, a string of up to 16 characters. This
field is required if the `Type` field is set to `CreditCard` or `DebitCard`.
This field can only be set when creating a new payment method; it cannot
be queried or updated. '
type: string
CreditCardPostalCode:
description: ' The billing address''s zip code. **Character limit**: 20
**Values**: a string of 20 characters or fewer '
type: string
CreditCardSecurityCode:
description: 'The CVV or CVV2 security code. See [How do I control what
information Zuora sends over to the Payment Gateway?](https://knowledgecenter.zuora.com/kb/How_do_I_control_information_sent_to_payment_gateways_when_verifying_payment_methods%3F)
for more information. To ensure PCI compliance, this value is not stored
and cannot be queried. '
type: string
CreditCardState:
description: ' The billing address''s state. Use this field if the `CreditCardCountry`
value is either Canada or the US. State names must be spelled in full. '
type: string
CreditCardType:
description: |
The type of the credit card. This field is required if the `Type` field is set to `CreditCard` or `DebitCard`.
Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).
type: string
DeviceSessionId:
description: " The session ID of the user when the `PaymentMethod` was created\
\ or updated. Some gateways use this field for fraud prevention. If this\
\ field is passed to Zuora, then Zuora passes this field to supported\
\ gateways. Currently only Verifi supports this field.\n**Character limit**:\
\ 255 **Values**: "
type: string
Email:
description: " An email address for the payment method in addition to the\
\ bill to contact email address.\n**Character limit**: 80 **Values**:\
\ a string of 80 characters or fewer "
type: string
ExistingMandate:
description: " Indicates if the customer has an existing mandate or a new\
\ mandate. A mandate is a signed authorization for UK and NL customers.\
\ When you are migrating mandates from another system, be sure to set\
\ this field correctly. If you indicate that a new mandate is an existing\
\ mandate or vice-versa, then transactions fail. This field is used only\
\ for the direct debit payment method.\n**Character limit**: 3 **Values**:\
\ `Yes`, `No` "
type: string
FirstName:
description: " The customer's first name. This field is used only for the\
\ direct debit payment method.\n**Character limit**: 30 **Values**: a\
\ string of 30 characters or fewer "
type: string
GatewayOptionData:
description: |
A field used to pass gateway options. Zuora allows you to pass in special gateway-specific parameters for payments through the [gateway integrations that support gateway options](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0#Gateway_Options).
For each of these special parameters, you supply the name-value pair and Zuora passes it to the gateway. This allows you to add functionality that's supported by a specific gateway but currently not supported by Zuora.
Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
properties:
GatewayOption:
description: ''
items:
$ref: '#/definitions/GatewayOption'
maxItems: 200
minItems: 0
type: array
required:
- GatewayOption
type: object
IBAN:
description: " The International Bank Account Number. This field is used\
\ only for the direct debit payment method.\n**Character limit**: 42 **Values**:\
\ a string of 42 characters or fewer "
type: string
IPAddress:
description: ' The IPv4 or IPv6 information of the user when the payment
method was created or updated. Gateways use this field for fraud prevention.
If this field is passed to Zuora, then Zuora passes this field to supported
gateways. If the IP address length is beyond 45 characters, a validation
error occurs. '
type: string
IdentityNumber:
description: |
The unique identity number of the customer account. This field is required for the following bank transfer payment methods:
- Denmark Direct Debit (Betalingsservice)
- Sweden Direct Debit (Autogiro)
It is a string of 12 characters for a Swedish identity number, and a string of 10 characters for a Denish identity number.
type: string
IsCompany:
default: false
description: "Whether the customer account is a company.\n\nZuora does not\
\ recommend that you use this field. \n"
type: boolean
LastName:
description: " The customer's last name. This field is used only for the\
\ direct debit payment method.\n**Character limit**: 70 **Values**: a\
\ string of 70 characters or fewer "
type: string
LastTransactionDateTime:
description: " The date of the most recent transaction.\n**Character limit**:\
\ 29 **Values**: a valid date and time value "
format: date-time
type: string
MandateCreationDate:
description: " The date when the mandate was created, in `yyyy-mm-dd` format.\
\ A mandate is a signed authorization for UK and NL customers. This field\
\ is used only for the direct debit payment method.\n**Character limit**:\
\ 29 "
format: date
type: string
MandateID:
description: " The ID of the mandate. A mandate is a signed authorization\
\ for UK and NL customers. This field is used only for the direct debit\
\ payment method.\n**Character limit**: 36 **Values**: a string of 36\
\ characters or fewer "
type: string
MandateReceived:
description: " Indicates if the mandate was received. A mandate is a signed\
\ authorization for UK and NL customers. This field is used only for the\
\ direct debit payment method.\n**Character limit**: 3 **Values**: `Yes`,\
\ `No `(case-sensitive) "
type: string
MandateUpdateDate:
description: " The date when the mandate was last updated, in `yyyy-mm-dd`\
\ format. A mandate is a signed authorization for UK and NL customers.\
\ This field is used only for the direct debit payment method.\n**Character\
\ limit**: 29 "
format: date
type: string
MaxConsecutivePaymentFailures:
description: " Specifies the number of allowable consecutive failures Zuora\
\ attempts with the payment method before stopping. When the `UseDefaultRetryRule`\
\ field is set to `false`, this field is only required if the `PaymentRetryWindow`\
\ field is not defined.\n**Values**: a valid number "
type: integer
MitConsentAgreementRef:
description: 'Specifies your reference for the stored credential consent agreement
that you have established with the customer. Only applicable if you set
the `MitProfileAction` field.
'
maxLength: 128
type: string
MitConsentAgreementSrc:
description: 'Required if you set the `MitProfileAction` field. If you do not specify the `MitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.
'
enum:
- External
type: string
MitNetworkTransactionId:
description: 'Specifies the ID of a network transaction. Only applicable if
you set the `MitProfileAction` field to `Persist`.
'
maxLength: 128
type: string
MitProfileAction:
enum:
- Activate
- Persist
type: string
description: 'Specifies how Zuora creates and activates a stored credential profile. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.'
MitProfileAgreedOn:
description: 'The date on which the profile is agreed. The date format is
`yyyy-mm-dd`.
'
format: date
type: string
MitProfileType:
description: 'Required if you set the `MitProfileAction` field. If you do not specify the `MitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.
'
enum:
- Recurring
type: string
NumConsecutiveFailures:
description: "The number of consecutive failed payments for this payment\
\ method. It is reset to `0` upon successful payment. \n"
format: int32
maximum: 100
minimum: 0
type: integer
PaymentRetryWindow:
description: " The retry interval setting, which prevents making a payment\
\ attempt if the last failed attempt was within the last specified number\
\ of hours. When the `UseDefaultRetryRule` field is set to `false`, this\
\ field is only required if the `MaxConsecutivePaymentFailures` field\
\ is not defined.\n**Character limit**: 4 **Values**: a whole number between\
\ 1 and 1000, exclusive "
type: integer
PaypalBaid:
description: " The PayPal billing agreement ID, which is a contract between\
\ two PayPal accounts. Typically, the selling party initiates a request\
\ to create a BAID, and sends it to buying party for acceptance. The seller\
\ can keep track of the BAID and use it for future charges against the\
\ buyer. This field is only required if the `Type` field is set to `PayPal`.\n\
**Character limit**: 64 **Values**: a string of 64 characters or fewer "
type: string
PaypalEmail:
description: " The email address associated with the account holder's PayPal\
\ account or of the PayPal account of the person paying for the service.\
\ This field is only required if the `Type` field is set to `PayPal`.\n\
**Character limit**: 80 **Values**: a string of 80 characters or fewer "
type: string
PaypalPreapprovalKey:
description: " PayPal's Adaptive Payments API key. Zuora does not create\
\ this key, nor does it call PayPal to generate it. You must use PayPal's\
\ Adaptive Payments' API to generate this key, and then pass it to Zuora.\
\ Zuora uses this key to authorize future payments to PayPal's Adaptive\
\ Payments API. This field is only required if you use PayPal Adaptive\
\ Payments gateway.\n**Character limit**: 32 **Values**: a valid PayPal\
\ Adaptive Payment pre-approval key "
type: string
PaypalType:
description: " Specifies the PayPal gateway: PayFlow Pro (Express Checkout)\
\ or Adaptive Payments. This field is only required if you use PayPal\
\ Adaptive Payments or Payflow Pro (Express Checkout) gateways.\n**Character\
\ limit**: 32 **Values**: `ExpressCheckout`, `AdaptivePayments` "
type: string
Phone:
description: " The phone number that the account holder registered with\
\ the bank. This field is used for credit card validation when passing\
\ to a gateway.\n**Character limit**: 40 **Values**: a string of 40 characters\
\ or fewer "
type: string
PostalCode:
description: " The zip code of the customer's address. This field is used\
\ only for the direct debit payment method.\n**Character limit**: 20 **Values**:\
\ a string of 20 characters or fewer "
type: string
SecondTokenId:
description: ' A gateway unique identifier that replaces sensitive payment
method data. `SecondTokenId` is conditionally required only when `TokenId`
is being used to represent a gateway customer profile. `SecondTokenId`
is used in the CC Reference Transaction payment method. **Character limit**:
64 **Values**: a string of 64 characters or fewer '
type: string
SkipValidation:
description: "If you set this field to `false`, Zuora will send an authorization\
\ request to the payment gateway. If the authorization fails, the Create\
\ Payment Method request will fail as well. If the user knows that the\
\ card number or token is valid, we recommend disabling this feature because\
\ authorization requests to the card network incur additional processing\
\ fees. Currently, Zuora sends all authorizations as keyed entries.\n\
If you set this field to `true`, the authorization request is not sent.\n\
**Character limit**: 5 **Values**: `true` or `false` "
type: boolean
State:
description: "The state of the customer's address. This field is used only\
\ for the direct debit payment method.\n**Character limit**: 70 **Values**:\
\ a string of 70 characters or fewer "
type: string
StreetName:
description: "The street name of the customer's address. This field is used\
\ only for the direct debit payment method.\n**Character limit**: 100\
\ **Values**: a string of 100 characters or fewer "
type: string
StreetNumber:
description: "The street number of the customer's address. This field is\
\ used only for the direct debit payment method.\n**Character limit**:\
\ 30 **Values**: a string of 30 characters or fewer "
type: string
TokenId:
description: "A gateway unique identifier that replaces sensitive payment\
\ method data or represents a gateway's unique customer profile. When\
\ `TokenId` is used to represent a customer profile, `SecondTokenId` is\
\ conditionally required for representing the underlying tokenized payment\
\ method. `TokenId` is required for the CC Reference Transaction payment\
\ method. The values for the `tokenId` and `secondTokenId` fields differ\
\ for gateways. For more information, see the Knowledge Center article\
\ specific to each gateway that supports the CC Reference Transaction\
\ payment method.\n**Character limit**: 255 **Values**: a string of 255\
\ characters or fewer "
type: string
Type:
description: "The type of payment method. \n\nIf you want to create an Amazon\
\ Pay payment method, specify `CreditCardReferenceTransaction` for this\
\ field. \n\nIf you want create a custom payment method, specify the name\
\ of the custom payment method type. This type is only available if the\
\ Universal Payment Connector and Open Payment Method services are enabled.\
\ See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods)\
\ for details.\n"
enum:
- ACH
- BankTransfer
- CreditCard
- CreditCardReferenceTransaction
- DebitCard
- PayPal
type: string
UseDefaultRetryRule:
description: "Determines whether to use the default retry rules configured\
\ in the Z-Payments settings. Set this to `true` to use the default retry\
\ rules. Set this to `false` to set the specific rules for this payment\
\ method. If you set this value to `false`, then the fields, `PaymentRetryWindow`\
\ and `MaxConsecutivePaymentFailures`, are required.\n**Character limit**:\
\ 5 **Values**: `true` or `false` "
type: boolean
currencyCode:
description: |
The currency used for payment method authorization.
If this field is not specified, `currency` specified for the account is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.
type: string
type: object
- $ref: '#/definitions/PaymentMethodObjectCustomFields'
example:
AccountId: 8ad09be48db5aba7018db604776d4854
Type: CreditCard
CreditCardType: Visa
CreditCardNumber: '4111111111111111'
CreditCardExpirationMonth: 12
CreditCardExpirationYear: 2020
CreditCardHolderName: Amy Lawrence
required:
- Type
ProxyCreateRefund:
allOf:
- properties:
AccountId:
description: " The ID of the account associated with this refund. This field\
\ is only required if you create a non-referenced refund. Don't specify\
\ a value for any other type of refund; Zuora associates the refund automatically\
\ with the account from the associated payment.\n**Character limit**:\
\ 32 **Values**: a valid account ID "
type: string
Amount:
description: " The amount of the refund. The amount can't exceed the amount\
\ of the associated payment. If the original payment was applied to a\
\ single invoice,\_you can create a partial refund by specifying an amount\
\ in this field or through the UI. If the payment was applied\_to multiple\
\ invoices, you can create a partial refund by using the `RefundInvoicePaymentData`\_\
field of this operation or through the UI.\n**Character limit**: 16 **Values**:\
\ a valid currency amount "
format: double
type: number
Comment:
description: " Use this field to record comments about the refund.\n**Character\
\ limit**: 255 **Values**: a string of 255 characters or fewer "
type: string
GatewayOptionData:
description: |
A field used to pass gateway options. Zuora allows you to pass in special gateway-specific parameters for payments through the [gateway integrations that support gateway options](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0#Gateway_Options).
For each of these special parameters, you supply the name-value pair and Zuora passes it to the gateway. This allows you to add functionality that's supported by a specific gateway but currently not supported by Zuora.
Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.
properties:
GatewayOption:
description: ''
items:
$ref: '#/definitions/GatewayOption'
maxItems: 200
minItems: 0
type: array
required:
- GatewayOption
type: object
GatewayState:
description: " The status of the payment in the gateway.\n**Character limit**:\
\ 19 **Values**: automatically generated "
type: string
MethodType:
description: |2
Indicates how an external refund was issued to a customer. This field is only required if the `Type` field is set to ` External`. You can issue an external refund on an electronic payment. **Character limit**: 30 **Values**:
- `ACH`
- `Cash`
- `Check`
- `CreditCard`
- `Other`
- `PayPal`
- `WireTransfer`
- `DebitCard`
- `CreditCardReferenceTransaction`
type: string
PaymentId:
description: " The unique ID of the payment associated with this refund.\
\ Don't specify a value for this field if you're creating an electronic\
\ non-referenced refund.\n**Character limit**: 32 **Values**: a valid\
\ payment ID "
type: string
PaymentMethodId:
description: " The unique ID of the payment method that the customer used\
\ to make the payment. This field is only required if you create a non-referenced\
\ refund.\n**Character limit**: 32 **V****alues**: a valid payment method\
\ ID "
type: string
ReasonCode:
description: " A code identifying the reason for the transaction. Must be\
\ an existing reason code or empty. If you do not specify a value, Zuora\
\ uses the default reason code.\n**Character limit**: 32 **V****alues**:\
\ a valid reason code "
type: string
RefundDate:
description: "The date of the refund, in `yyyy-mm-dd` format. The date of\
\ the refund cannot be before the payment date. This field is only required\
\ if the `Type` field is set to ` External`. Zuora automatically generates\
\ this field for electronic refunds.\n\nWith the Future Dated Credit Balance\
\ Adjustment feature enabled, you can create a non-referenced refund with\
\ a refund date. \n* For external refunds, you can specify any date.\n\
* For electronic refunds, you can only set the date to the date when the\
\ API operation is called or one day later.\n"
format: date
maxLength: 29
type: string
RefundInvoicePaymentData:
description: 'Container for the refund invoice payment data. This field
is only required if you apply a full or partical refund against a payment
attached to muliple invoices.
'
properties:
RefundInvoicePayment:
description: ''
items:
$ref: '#/definitions/RefundInvoicePayment'
maxItems: 200
minItems: 0
type: array
required:
- RefundInvoicePayment
type: object
SoftDescriptor:
description: |2
A payment gateway-specific field that maps Zuora to other gateways . **Character limit**: 35 **Values**:
- 3-byte company identifier "*" 18-byte descriptor
- 7-byte company identifier "*" 14-byte descriptor
- 12-byte company identifier "*" 9-byte descriptor
type: string
SoftDescriptorPhone:
description: |2
A payment gateway-specific field that maps Zuora to other gateways . **Character limit**: 20 **Values**:
- Customer service phone number formatted as: `NNN-NNN-NNNN` or `NNN-AAAAAAA`
- URL (non-e-Commerce): Transactions sent with a URL do not qualify for the best interchange rate
- Email address
type: string
SourceType:
description: |2
Specifies whether the refund is a refund payment or a credit balance. This field is only required if you create a non-referenced refund. If you creating an non-referenced refund, then set this value to `CreditBalance`.
**Note**: If you have the Invoice Settlement feature enabled, the value of this field can only be set to `Payment`.
**Character limit**: 13 **Values**:
- `Payment`
- `CreditBalance`
type: string
Type:
description: |2
Specifies if the refund is electronic or external.
**Character limit**: 10 **Values**:
- `Electronic`
- `External`
type: string
required:
- Amount
- Type
type: object
- $ref: '#/definitions/RefundObjectNSFields'
- $ref: '#/definitions/RefundObjectCustomFields'
example:
AccountId: 2c93808457d787030157e03190e748ea
Amount: 1.1
Comment: this is comments
PaymentId: 2c93808457d787030157e03197714910
ReasonCode: Standard Refund
RefundInvoicePaymentData:
RefundInvoicePayment:
- InvoiceId: 2c93808457d787030157e03195604902
RefundAmount: 1.1
SoftDescriptor: thisSD
SoftDescriptorPhone: contact@example.com
SourceType: Payment
Type: Electronic
ProxyCreateUnitOfMeasure:
example:
Active: true
DecimalPlaces: 9
DisplayedAs: name_display_name_1476935033519
RoundingMode: UP
UomName: name_1476935033519
properties:
Active:
description: " Indicates if the UOM is available for new product rate plans.\
\ The default value is `true`.\n**Character limit**: 5 **Values**: `true`,\
\ `false ` "
type: boolean
DecimalPlaces:
description: 'The number of digits to the right of the decimal point that
you want to measure for the unit. To use whole numbers only, set this value
to 0. You can''t change this value after this `UOM` is used in any product,
subscription, or usage. **Character limit**: 1 **Values**: an integer between
0 and 9, exclusive '
format: int64
type: integer
DisplayedAs:
description: 'The name of the UOM that you want displayed on invoices. The
default value is the `UomName` field value. **Character limit**: 50 **Values**:
A string of 50 characters or fewer '
type: string
RoundingMode:
description: " Specifies whether to round the UOM value up or down when the\
\ value exceeds the `DecimalPlaces` field value. The default value is `Up`.\n\
**Character limit**: 4 **Values**: `Up`, `Down` "
type: string
UomName:
description: " The name of the UOM, such as license or GB. This name is displayed\
\ in query results and in the web-based UI labels. If you want a different\
\ name to be displayed on invoices, then use the `DisplayedAs` field to\
\ provide the invoice label.\n**Character limit**: 50 **Values**: a string\
\ of 50 characters or fewer "
type: string
required:
- DecimalPlaces
- UomName
type: object
ProxyDeleteResponse:
properties:
id:
description: ''
type: string
success:
description: ''
type: boolean
type: object
ProxyGetAccount:
allOf:
- properties:
AccountNumber:
description: |
Unique account number assigned to the account. **Character limit**: 50 **Values**: one of the following:
- null to auto-generate
- a string of 50 characters or fewer that doesn't begin with the default account number prefix
type: string
AdditionalEmailAddresses:
description: 'List of additional email addresses to receive email notifications.
**Character limit**: 120 **Values**: comma-separated list of email addresses '
type: string
AllowInvoiceEdit:
description: " Indicates if associated invoices can be edited.\n**Character\
\ limit**: 5 **Values**: `true`, `false` (default if left null) "
type: boolean
AutoPay:
description: " Indicates if future payments are automatically collected\
\ when they're due during a Payment Run.\n**Character limit**: 5 **Values**:\
\ `true`, `false` (default) "
type: boolean
Balance:
description: 'Current outstanding balance for the account. **Character limit**:
16 **Values**: automatically generated '
format: double
type: number
Batch:
description: " Organizes your customer accounts into groups to optimize\
\ your billing and payment operations. Required if you use the Subscribe\
\ call\n**Character limit**: 20 **Values**:any system-defined batch (`Batch1`\
\ - `Batch50 `or by name). "
type: string
BcdSettingOption:
description: 'Billing cycle day setting option. **Character limit**: 9 **Values**:
`AutoSet`, `ManualSet` '
type: string
BillCycleDay:
description: 'Billing cycle day (BCD) on which bill runs generate invoices
for the account. **Character limit**: 2 **Values**: any activated system-defined
bill cycle day (`1` - `31`) '
format: int32
type: integer
BillToId:
description: 'ID of the person to bill for the account. **Character limit**:
32 **Values**: a valid contact ID for the account '
type: string
CommunicationProfileId:
description: 'Associates the account with a specified communication profile.
**Character limit**: 32 **Values**: a valid communication profile ID '
type: string
CreatedById:
description: 'ID of the Zuora user who created the Account object. **Character
limit**: 32 **Values**: automatically generated '
type: string
CreatedDate:
description: 'Date when the Account object was created. **Character limit**:
29 **Values**: automatically generated '
format: date-time
type: string
CreditBalance:
description: 'Total credit balance for the account. **Character limit**:
16 **Values**: automatically generated '
format: double
type: number
CrmId:
description: 'CRM account ID for the account. A CRM is a customer relationship
management system, such as Salesforce.com. **Character limit**: 100 **Values**:
a string of 100 characters or fewer '
type: string
Currency:
description: ' Currency that the customer is billed in. '
type: string
CustomerServiceRepName:
description: 'Name of the account''s customer service representative, if
applicable. **Character limit**: 50 **Values**: a string of 50 characters
or fewer '
type: string
DefaultPaymentMethodId:
description: 'ID of the default payment method for the account. This field
is required if the AutoPay field is set to `true`. **Character limit**:
32 **Values**: a valid ID for an existing payment method '
type: string
Id:
description: Object identifier.
type: string
InvoiceDeliveryPrefsEmail:
description: 'Indicates if the customer wants to receive invoices through
email. **Character limit**: 5 **Values**: `true`, `false` (default if
left null) '
type: boolean
InvoiceDeliveryPrefsPrint:
description: 'Indicates if the customer wants to receive printed invoices,
such as through postal mail. **Character limit**: 5 **Values**: `true`,
`false` (default if left null) '
type: boolean
InvoiceTemplateId:
description: 'The ID of the invoice template. Each customer account can
use a specific invoice template for invoice generation. **Character limit**:
32 **Values**: a valid template ID configured in Zuora Billing Settings '
type: string
LastInvoiceDate:
description: " The date when the previous invoice was generated for the\
\ account. The field value is null if no invoice has ever been generated\
\ for the account.\n**Character limit**: 29 **Values**: automatically\
\ generated "
format: date
type: string
LastMetricsUpdate:
type: string
format: date-time
description: |
The date and time when account metrics are last updated, if the account is a partner account.
**Note**:
- This field is available only if you have the Reseller Account feature enabled.
- If you have the Reseller Account feature enabled, and set the `PartnerAccount` field to `false` for an account, the value of the `lastMetricsUpdate` field is automatically set to `null` in the response.
- If you ever set the `PartnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated.
- This field is only available if you set the `X-Zuora-WSDL-Version` request header to `131` or later.
Name:
description: 'Name of the account as displayed in the Zuora UI. **Character
limit**: 255 **Values**: a string of 255 characters or fewer '
type: string
Notes:
description: ' Comments about the account. **Character limit**: 65,535 **Values**:
a string of 65,535 characters '
type: string
ParentId:
description: 'Identifier of the parent customer account for this Account
object. Use this field if you have customer hierarchy enabled. **Character
limit**: 32 **Values**: a valid account ID '
type: string
PartnerAccount:
type: boolean
default: false
description: |
Whether the customer account is a partner, distributor, or reseller.
**Note**:
- This field is available only if you have the Reseller Account feature enabled.
- This field is only available if you set the `X-Zuora-WSDL-Version` request header to `131` or later.
PaymentGateway:
description: |
Gateway used for processing electronic payments and refunds. **Character limit**: 40 **Values**: one of the following:
- a valid configured gateway name
- Null to inherit the default value set in Payment Settings
type: string
PaymentTerm:
description: 'Indicates when the customer pays for subscriptions. **Character
limit**: 100 **Values**: a valid, active payment term defined in the web-based
UI administrative settings '
type: string
PurchaseOrderNumber:
description: 'The number of the purchase order associated with this account.
Purchase order information generally comes from customers. **Character
limit**: 100 **Values**: a string of 100 characters or fewer '
type: string
SalesRepName:
description: 'The name of the sales representative associated with this
account, if applicable. **Character limit**: 50 **Values**: a string of
50 characters or fewer '
type: string
SoldToId:
description: 'ID of the person who bought the subscription associated with
the account. **Character limit**: 32 **Values**: a valid contact ID for
the account '
type: string
Status:
description: 'Status of the account in the system.
'
enum:
- Draft
- Active
- Canceled
type: string
TaxCompanyCode:
description: " Unique code that identifies a company account in Avalara.\
\ Use this field to calculate taxes based on origin and sold-to addresses\
\ in Avalara.\nThis 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**Character limit**: 50 **Values**: a valid company code "
type: string
TaxExemptCertificateID:
description: 'ID of your customer''s tax exemption certificate. **Character
limit**: 32 **Values**: a string of 32 characters or fewer '
type: string
TaxExemptCertificateType:
description: 'Type of the tax exemption certificate that your customer holds. **Character
limit**: 32 **Values**: a string of 32 characters or fewer '
type: string
TaxExemptDescription:
description: 'Description of the tax exemption certificate that your customer
holds. **Character limit**: 500 **Values**: a string of 500 characters
or fewer '
type: string
TaxExemptEffectiveDate:
description: 'Date when the the customer''s tax exemption starts. **Character
limit**: 29 **Version notes**: requires Zuora Tax '
format: date
type: string
TaxExemptExpirationDate:
description: 'Date when the customer''s tax exemption certificate expires **Character
limit**: 29 **Version notes**: requires Zuora Tax '
format: date
type: string
TaxExemptIssuingJurisdiction:
description: 'Indicates the jurisdiction in which the customer''s tax exemption
certificate was issued. **Character limit**: 32 **Values**: a string of
32 characters or fewer '
type: string
TaxExemptStatus:
description: |2
Status of the account's tax exemption. Required if you use Zuora Tax.
**Character limit**: 19 **Values**: one of the following:
- `Yes`
- `No`
- `PendingVerification`
type: string
TotalInvoiceBalance:
description: 'Total balance of the account''s invoices. **Character limit**:
16 **Values**: a valid currency value '
format: double
type: number
UpdatedById:
description: 'ID of the user who last updated the account. **Character limit**:
32 **Values**: automatically generated '
type: string
UpdatedDate:
description: 'Date when the account was last updated. **Character limit**:
29 **Values**: automatically generated '
format: date-time
type: string
VATId:
description: " EU Value Added Tax ID.\nThis 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**Character limit**:\
\ 25 **Values**: a valid Value Added Tax ID "
type: string
type: object
- $ref: '#/definitions/AccountObjectNSFields'
- $ref: '#/definitions/AccountObjectCustomFields'
ProxyGetAmendment:
allOf:
- 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. **Required:** For amendment of type TermsAndConditions when\
\ changing the automatic renewal status of a subscription.\n**Values**:\
\ true, false "
type: boolean
Code:
description: |2
A unique alphanumeric string that identifies the amendment.
**Character limit**: 50 **Values**: one of the following:
- `null` generates a value automatically
- A string
type: string
ContractEffectiveDate:
description: " The date when the amendment's changes become effective for\
\ billing purposes.\n**Version notes**: -- "
format: date
type: string
CreatedById:
description: " The user ID of the person who created the amendment.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the amendment was created.\n**Values**: automatically\
\ generated "
format: date-time
type: string
CurrentTerm:
description: " The length of the period for the current subscription term.\
\ This field can be updated when Status is `Draft`.\n**Required**: Only\
\ if the value of the Type field is set to `TermsAndConditions` and TermType\
\ is set to `TERMED`. This field is not required if TermType is set to\
\ `EVERGREEN`.\n**Character limit**: **Values**: a valid number "
format: int64
type: integer
CurrentTermPeriodType:
description: |2
The period type for the current subscription term. **Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
**Note**:
- This field can be updated when Status is `Draft`.
- This field is used with the CurrentTerm field to specify the current subscription term.
type: string
CustomerAcceptanceDate:
description: |
The date when the customer accepts the amendment's changes to the subscription.
This field is only required if [Zuora is configured to require customer acceptance in Z-Billing](https://knowledgecenter.zuora.com/CB_Billing/W_Billing_and_Payments_Settings/Define_Default_Subscription_Settings) and the subscription is currently in the Pending Acceptance status (the value of the `Status` field is currently `PendingAcceptance`).
format: date
type: string
Description:
description: " A description of the amendment.\n**Character limit**: 500\
\ **Values**: maximum 500 characters "
type: string
EffectiveDate:
description: " The date when the amendment's changes take effective. This\
\ field validates that the amendment's changes are within valid ranges\
\ of products and product rate plans.\n**Required**: For the cancellation\
\ amendments. Optional for other types of amendments.\n**Version notes**:\
\ -- "
format: date
type: string
Id:
description: Object identifier.
type: string
Name:
description: " The name of the amendment.\n**Character limit**: 100 **Values**:\
\ a string of 100 characters or fewer "
type: string
RenewalSetting:
description: " Specifies whether a termed subscription will remain termed\
\ or change to evergreen when it is renewed.\n**Required**: If TermType\
\ is Termed **Values**: RENEW_WITH_SPECIFIC_TERM (default), RENEW_TO_EVERGREEN "
type: string
RenewalTerm:
description: " The term of renewal for the amended subscription. This field\
\ can be updated when Status is `Draft`.\n**Required**: Only if the value\
\ of the Type field is set to `TermsAndConditions`.\n**Character limit**:\
\ **Values:** a valid number "
format: int64
type: integer
RenewalTermPeriodType:
description: |2
The period type for the subscription renewal term. This field can be updated when Status is `Draft`.
**Required**: Only if the value of the Type field is set to `TermsAndConditions`. This field is used with the RenewalTerm field to specify the subscription renewal term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
type: string
ServiceActivationDate:
description: |
The date when service is activated.
This field is only required if [Zuora is configured to require service activation in Z-Billing](https://knowledgecenter.zuora.com/CB_Billing/W_Billing_and_Payments_Settings/Define_Default_Subscription_Settings) and the subscription is currently in the Pending Activation status (the value of the `Status` field is currently `PendingActivation`).
format: date
type: string
SpecificUpdateDate:
description: " The date when the UpdateProduct amendment takes effect. This\
\ field is only applicable if there is already a future-dated UpdateProduct\
\ amendment on the subscription.\n**Required**: Only for the UpdateProduct\
\ amendments if there is already a future-dated UpdateProduct amendment\
\ on the subscription.\n**Version notes**: -- "
format: date
type: string
Status:
description: |2
The status of the amendment. Type: string (enum) **Character limit**: 17 **Values**: one of the following:
- Draft (default, if left null)
- Pending Activation
- Pending Acceptance
- Completed
type: string
SubscriptionId:
description: " The ID of the subscription that the amendment changes.\n\
**Character limit**: 32 **Values**: a valid subscription ID "
type: string
TermStartDate:
description: " The date when the new terms and conditions take effect.\n\
\n\n**Version notes**: -- "
format: date
type: string
TermType:
description: " Indicates if the subscription isTERMED or EVERGREEN.\n\n\
- A TERMED subscription has an expiration date, and must be manually renewed.\n\
- An EVERGREEN subscription doesn't have an expiration date, and must\
\ be manually ended.\n\n**Required**: Only when as part of an amendment\
\ of type TermsAndConditions to change the term type of a subscription.\
\ Type: string **Character limit**: 9 **Values**: TERMED, EVERGREEN "
type: string
Type:
description: |2
The type of amendment.
**Character limit**: 18 **Values**: one of the following:
- Cancellation
- NewProduct
- OwnerTransfer
- RemoveProduct
- Renewal
- UpdateProduct
- TermsAndConditions
- SuspendSubscription
- ResumeSubscription
type: string
UpdatedById:
description: " The ID of the user who last updated the amendment.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the amendment was last updated.\n**Values**:\
\ automatically generated "
format: date-time
type: string
type: object
- $ref: '#/definitions/AmendmentObjectCustomFields'
ProxyGetCommunicationProfile:
properties:
CreatedById:
description: 'The ID of the Zuora user who created the communication profile.'
type: string
CreatedDate:
description: 'The date when the communication profile was created.'
format: date-time
type: string
Description:
description: 'The description of the communication profile.'
type: string
Id:
description: Object identifier.
type: string
IsDefault:
description: 'Whether the profile is the default communication profile.'
type: boolean
Muted:
description: 'Whether the communication profile is disabled or enabled. `true` indicates the communication profile is disabled (muted). Zuora does not send email or callout notifications in a disabled communication profile.'
type: boolean
ProfileName:
description: 'The name of the communication profile.'
type: string
ProfileNumber:
description: 'The number of a communication profile. The value is assigned by Zuora during the creation and is unique across different communication profiles.'
type: string
UpdatedById:
description: 'The ID of the Zuora user who last updated the communication profile.'
type: string
UpdatedDate:
description: 'The date when the communication profile was last updated.'
format: date-time
type: string
type: object
ProxyGetCreditBalanceAdjustment:
allOf:
- properties:
AccountId:
description: |2
The account ID of the credit balance's account. Zuora generates this value from the source transaction.
**Character limit**: 32 **Values**: automatically generated from:
- CreditBalanceAdjustment.SourceTransactionId or
- CreditBalanceAdjustment.SourceTransactionNumber
type: string
AccountingCode:
description: ' The Chart of Accounts '
type: string
AdjustmentDate:
description: " The date when the credit balance adjustment is applied.\n\
**Character limit**: 29 **Values**: automatically generated "
format: date
type: string
Amount:
description: " The amount of the adjustment.\n**Character limit**: 16 **Values**:\
\ a valid currency amount "
format: double
type: number
CancelledOn:
description: " The date when the credit balance adjustment was canceled.\n\
**Character limit**: 29 **Values**: automatically generated "
format: date-time
type: string
Comment:
description: " Use this field to record comments about the credit balance\
\ adjustment.\n**Character limit**: 255 **Values**: a string of 255 characters\
\ or fewer "
type: string
CreatedById:
description: " The user ID of the person who created the credit balance\
\ adjustment.\n**Character limit**: 32 **Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the credit balance adjustmentwas generated.\n\
**Character limit**: 29 **Values**: automatically generated "
format: date-time
type: string
Id:
description: Object identifier.
type: string
Number:
description: " A unique identifier for the credit balance adjustment. Zuora\
\ generates this number in the format, CBA-xxxxxxxx, such as\
\ CBA-00375919.\n**Character limit**: 255 **Values**: automatically generated "
type: string
ReasonCode:
description: " A code identifying the reason for the transaction. Must be\
\ an existing reason code or empty. If you do not specify a value, Zuora\
\ uses the default reason code.\n**Character limit**: 32 **Values**: a\
\ valid reason code "
type: string
ReferenceId:
description: " The ID of the payment that the credit balance adjustment\
\ is for.\n**Character limit**: 100 **Values**: a string of 100 characters\
\ or fewer "
type: string
SourceTransactionId:
description: |2
The ID of the object that the credit balance adjustment is applied to. You must specify a value for either the `SourceTransactionId` field or the `SourceTransactionNumber` field.
**Character limit**: 32 **Values**: one of the following:
- InvoiceId
- PaymentId
- RefundId
type: string
SourceTransactionNumber:
description: |2
The number of the object that the credit balance adjustment is applied to. You must specify a value for either the `SourceTransactionId` field or the `SourceTransactionNumber` field.
**Character limit**: 50 **Values**: one of the following:
- InvoiceNumber
- PaymentNumber
- RefundNumber
type: string
SourceTransactionType:
description: |2
The source of the credit balance adjustment.
**Character limit**: **Values**: automatically generated; one of the following:
- Invoice
- Payment
- Refund
type: string
Status:
description: |2
The status of the credit balance adjustment.
**Character limit**: 9 **Values**: automatically generated; one of the following:
- Processed
- Canceled
type: string
TransferredToAccounting:
description: 'Status of the credit balance adjustment''s transfer to an
external accounting system, such as NetSuite.
'
enum:
- Processing
- 'Yes'
- 'No'
- Error
- Ignore
type: string
Type:
description: Create Query Filter
type: string
UpdatedById:
description: " The ID of the user who last updated the credit balance adjustment.\n\
**Character limit**: 32 **Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the credit balance adjustment was last updated.\n\
**Character limit**: 29 **Values**: automatically generated "
format: date-time
type: string
type: object
- $ref: '#/definitions/CreditBalanceAdjustmentObjectNSFields'
- $ref: '#/definitions/CreditBalanceAdjustmentObjectCustomFields'
ProxyGetExport:
properties:
ConvertToCurrencies:
description: " The currencies that you want to convert transaction amounts\
\ into. You can specify any number of currencies. Specify the currencies\
\ using their Foreign Currency Conversion enabled to use this field.\n**Character\
\ limit**: **Values**: a list of valid currency codes "
type: string
CreatedById:
description: " The user ID of the person who created the export.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the import was created.\n**Character limit**:\
\ 29 **Values**: automatically generated "
format: date-time
type: string
Encrypted:
description: " Exports a secure version of encrypted data source fields. such\
\ as the AchAccountNumber field of the PaymentMethod object and the DefaultPaymentMethod\
\ data souce objects.\n**Character limit**: 5 **Values:** true, false "
type: boolean
FileId:
description: " The ID of the file generated by an export query. This file\
\ is automatically generated when an Export object is created. Use this\
\ file ID with [Get files](https://developer.zuora.com/api-references/api/operation/GET_Files)\
\ to download the export file.\n**Character limit**: 32 **Values**: automatically\
\ generated "
type: string
Format:
description: " The format that you want the export file to use.\n**Character\
\ limit**: 5 "
enum:
- csv
- html
- Excel
type: string
Id:
description: Object identifier.
type: string
Name:
description: " The name of the export.\n**Character limit**: 255 **Values**:\
\ a string of 255 characters or fewer "
type: string
Query:
description: '[Export ZOQL](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL)
query.
'
type: string
Size:
description: " The number of records or rows exported. This field value is\
\ null until the export status is Completed.\n**Character limit**: **Values**:\
\ automatically generated "
format: int32
type: integer
Status:
description: |2
The status of the export. Type: string (enum) **Character limit**: 10 **Values**: automatically generated to be one of the following values:
- Pending
- Processing
- Completed
- Canceled
- Failed
type: string
StatusReason:
description: " The reason for the given status. Use this information to help\
\ ascertain why an export failed.\n**Character limi**t: 255 **Values**:\
\ automatically generated "
type: string
UpdatedById:
description: " The ID of the user who last updated the export.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the expotr was last updated.\n**Character limit**:\
\ 29 **Values**: automatically generated "
format: date-time
type: string
Zip:
description: " Indicates if you want the resulting export file to be compressed\
\ into a zip file.\n**Character limit**: **Values**: true, false (default) "
type: boolean
type: object
ProxyGetFeature:
allOf:
- properties:
CreatedById:
description: ' Internal Zuora ID of the user who created the feature **Character
limit**: 32 '
type: string
CreatedDate:
description: ' Date and time when the feature was created **Character limit**:
29 '
format: date-time
type: string
Description:
description: ' Description of the feature **Character limit**: 1000 '
type: string
FeatureCode:
description: ' Unique code of the feature **Character limit**: 255 '
type: string
Id:
description: Object identifier.
type: string
Name:
description: ' Name of the feature **Character limit**: 255 '
type: string
Status:
description: ' Status of the feature, Active or Inactive **Character limit**:
8 '
type: string
UpdatedById:
description: ' Internal Zuora ID of the user who last updated the feature
**Character limit**: 32 '
type: string
UpdatedDate:
description: ' Date and time when the feature was last updated **Character
limit**: 29 '
format: date-time
type: string
type: object
- $ref: '#/definitions/FeatureObjectCustomFields'
ProxyGetInvoiceAdjustment:
allOf:
- properties:
AccountId:
description: " The ID of the account that owns the invoice.\n**Character\
\ limit**: 32 **Values**: inherited from Account.ID for the invoice owner "
type: string
AccountingCode:
description: 'The accounting code for the invoice adjustment. '
type: string
AdjustmentDate:
description: " The date when the invoice adjustment is applied. This date\
\ must be the same as the invoice's date or later.\n**Character limit**:\
\ 29 **Values**: Leave null to automatically generate the current date "
format: date
type: string
AdjustmentNumber:
description: " A unique string to identify an individual invoice adjustment.\n\
**Character limit**: 255 **Values**: automatically generated "
type: string
Amount:
description: " The amount of the invoice adjustment.\n**Character limit**:\
\ 16 **Values**: a valid currency amount "
format: double
type: number
CancelledById:
description: " The ID of the Zuora user who canceled the invoice adjustment.\
\ Zuora generates this read-only field only if the adjustment is canceled.\n\
**Character limit**: 32 **Values**: automatically generated "
type: string
CancelledOn:
description: " The date when the invoice adjustment is canceled. Zuora generates\
\ this read-only field if this adjustment is canceled.\n**Character limit**:\
\ 29 **Values**: automatically generated "
format: date-time
type: string
Comments:
description: " Use this field to record comments about the invoice adjustment.\n\
**Character limit**: 255 **Values**: a string of 255 characters or fewer "
type: string
CreatedById:
description: " The user ID of the person who created the invoice adjustment.\n\
**Character limit**: 32 **Values**: automatically generated "
type: string
CreatedDate:
description: " The date the invoice adjustment was created.\n**Character\
\ limit**: 29 **Values**: automatically generated "
format: date-time
type: string
CustomerName:
description: " The name of the account that owns the associated invoice.\n\
\n**Character limit**: 50\n\n**Values**: inherited from `Account.Name`\n\
\n**Note**: This value changes if `Account.Name` is updated. The values\
\ of `UpdatedById` and `UpdatedDate` for the `InvoiceAdjustment` do not\
\ change when `Account.Name` is updated. "
type: string
CustomerNumber:
description: " The unique account number of the customer's account.\n\n\
**Character limit**: 70\n\n**Values**: inherited from `Account.AccountNumber`\n\
\n**Note**: This value changes if `Account.AccountNumber` is updated.\
\ The values of `UpdatedById` and `UpdatedDate` for the `InvoiceAdjustment`\
\ do not change when `Account.AccountNumber` is updated. "
type: string
Id:
description: Object identifier.
type: string
ImpactAmount:
description: " The amount that changes the balance of the associated invoice.\n\
**Character limit**: 16 **Values**: automatically calculated "
format: double
type: number
InvoiceId:
description: " The ID of the invoice associated with the adjustment. This\
\ field is required if you don't specify a value for the `InvoiceNumber`\
\ field.\n**Character limit**: 32 **Values**: a valid invoice ID "
type: string
InvoiceNumber:
description: " The unique identification number for the associated invoice.\
\ This field is required if you don't specify a value for the `InvoiceId`\
\ field.\n**Character limit**: 32 **Values**: a valid invoice number "
type: string
ReasonCode:
description: " A code identifying the reason for the transaction. Must be\
\ an existing reason code or empty. If you do not specify a value, Zuora\
\ uses the default reason code.\n**Character limit**: 32 **V****alues**:\
\ a valid reason code "
type: string
ReferenceId:
description: " A code to reference an object external to Zuora. For example,\
\ you can use this field to reference a case number in an external system.\n\
**Character limit**: 60 **Values**: a string of 60 characters or fewer "
type: string
Status:
description: " The status of the invoice adjustment. This field is required\
\ in the Query call, but is automatically generated in other calls.\n\
**Character limit**: 9 **Values**: `Canceled`, `Processed` "
type: string
TransferredToAccounting:
description: 'Indicates the status of the adjustment''s transfer to an external
accounting system, such as NetSuite.
'
enum:
- Processing
- 'Yes'
- 'No'
- Error
- Ignore
type: string
Type:
description: " Indicates whether the adjustment credits or debits the invoice\
\ amount.\n**Character limit**: 6 **Values**: `Credit`, `Charge` "
type: string
UpdatedById:
description: " The ID of the user who last updated the invoice.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the invoice was last updated.\n**Character\
\ limit**: 29 **Values**: automatically generated "
format: date-time
type: string
type: object
- $ref: '#/definitions/InvoiceAdjustmentObjectCustomFields'
ProxyGetInvoiceItem:
allOf:
- properties:
AccountingCode:
description: " The accounting code for the item's charge. Accounting codes\
\ group transactions that contain similar accounting attributes.\n**Character\
\ limit**: 100 **Values**: inherited from `RatePlanCharge.AccountingCode` "
type: string
AppliedToInvoiceItemId:
description: " Associates a discount invoice item to a specific invoice\
\ item.\n\n**Character limit**: 32\n\n**Values**: inherited from `InvoiceItem.Id`\
\ for the invoice item that the discount charge is applied 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**Character limit**: **Values**: automatically calculated\
\ from multiple fields in multiple objects "
format: double
type: number
ChargeDate:
description: " The date when the Invoice Item is created .\n**Character\
\ limit**: 29 **Values**: automatically generated "
format: date-time
type: string
ChargeName:
description: " The name of the invoice item's charge.\n**Character limi**t:\
\ 50 **Values: **inherited from `RatePlanCharge.Name` "
type: string
CreatedById:
description: " The user ID of the person who created the invoice item.\n\
**Character limit**: 32 **Values**: automatically generated "
type: string
CreatedDate:
description: " The date the invoice item was created.\n**Character limit:**\
\ 29 **Values**: automatically generated "
format: date-time
type: string
ExcludeItemBillingFromRevenueAccounting:
description: ' Whether excluding item from revenue accounting. The flag
to exclude non-revenue related invoice items, invoice item adjustments,
credit memo items, and debit memo items from revenue accounting. **Note**:
This field is only available if you have the RevPro Integration feature
enabled. And you must set the `X-Zuora-WSDL-Version` request header to
`116` or later. Otherwise, an error occurs. **Character limit**: 8 **Values**:
Default value is false, inherited from order line item. '
type: boolean
Id:
description: Object identifier.
type: string
InvoiceId:
description: " The ID of the invoice that's associated with this invoice\
\ item.\n**Character limit**: 32 **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**Character limit**: 500\n\n**Values**: inherited from `Product.Description`\n\
\n**Note**: This value changes if `Product.Description` is updated. The\
\ values of `UpdatedById` and `UpdatedDate` for the `InvoiceItem` do not\
\ change when `Product.Description` is updated. "
type: string
ProductName:
description: " The name of the product associated with this invoice item.\n\
\n**Character limit**: 255\n\n**Values**: inherited from `Product.Name`\n\
\n**Note**: This value changes if `Product.Name` is updated. The values\
\ of `UpdatedById` and `UpdatedDate` for the `InvoiceItem` do not change\
\ when `Product.Name` is updated. "
type: string
Quantity:
description: " The number of units for this invoice item.\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**Character limit**: 32 **Values**: inherited from `RatePlanCharge.Id` "
type: string
RevRecStartDate:
description: " The date when revenue recognition is triggered.\n**Character\
\ limit**: 29 **Values**: generated from `InvoiceItem.RevRecTriggerCondition` "
format: date
type: string
SKU:
description: " The unique SKU for the product associated with this invoice\
\ item.\n**Character limit**: 255 **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**Character\
\ limit**: 29 **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 **Values**:\
\ automatically generated "
format: date
type: string
SourceItemType:
description: |2
The type of the source item. **Note**: To use this field, you must set the `X-Zuora-WSDL-Version` request header to `118` or later. Otherwise, an error occurs. **Character limit**: 16 **Values**: one of the following enum values:
- SubscriptionComponent
- Rounding
- ProductRatePlanCharge
- None
- OrderLineItem
type: string
SubscriptionId:
description: " The ID of the subscription associated with the invoice item.\n\
**Character limit**: 32 **Values**: inherited from `Subscription.Id` "
type: string
TaxAmount:
description: " The amount of tax applied to the invoice item's charge.\n\
**Character limit**: **Values**: calculated from multiple fields in the\
\ ProductRatePlanCharge object "
format: double
type: number
TaxCode:
description: " Specifies the tax code for taxation rules.\n**Character limit**:\
\ 6 **Values**: inherited from `ProductRatePlanCharge.TaxCode` "
type: string
TaxExemptAmount:
description: " The calculated tax amount excluded due to the exemption.\n\
**Character limit**: **Values**: calculated from multiple fields in the\
\ ProductRatePlanCharge object "
format: double
type: number
TaxMode:
description: " The tax mode of the invoice item.\n**Character limit**: 12\
\ **Values**: `TaxExclusive`, `TaxInclusive` "
type: string
UOM:
description: ' Specifies the units to measure usage. **Character limit**:
**Values**: inherited from `ProductRatePlanCharge.UOM` '
type: string
UnitPrice:
description: " The per-unit price of the invoice item.\n**Character limit**:\
\ **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**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the invoice item was last updated.\n**Character\
\ limit**: 29 **Values**: automatically generated "
format: date-time
type: string
type: object
- $ref: '#/definitions/InvoiceItemObjectNSFields'
- $ref: '#/definitions/InvoiceItemObjectCustomFields'
ProxyGetInvoiceItemAdjustment:
allOf:
- properties:
AccountId:
description: " The ID of the account that owns the invoice.\n**Values**:\
\ inherited from `Account.ID` for the invoice owner "
type: string
AccountingCode:
description: " The accounting code for the invoice item. Accounting codes\
\ group transactions that contain similar accounting attributes.\n**Character\
\ limit**: 100 **Values**: inherited from `InvoiceItem.AccountingCode` "
type: string
AdjustmentDate:
description: " The date when the invoice item adjustment is applied, in\
\ `yyyy-mm-dd` format. This date must be the same as the invoice's date\
\ or later.\n**Character limit**: 29 "
format: date
type: string
AdjustmentNumber:
description: " A unique string to identify an individual invoice item adjustment.\n\
**Character limit**: 255 **Values**: automatically generated "
type: string
Amount:
description: ' The amount of the invoice item adjustment. The value of Amount
must be positive. Use the required parameter Type to either credit or
charge (debit) this amount on the invoice. **Character limit**: 16 **Values**:
a valid currency amount '
format: double
type: number
CancelledById:
description: " The ID of the Zuora user who canceled the invoice item adjustment.\
\ Zuora generates this read-only field only if the adjustment is canceled.\n\
**Character limit**: 32 **Values**: automatically generated "
type: string
CancelledDate:
description: " The date when the invoice item adjustment is canceled. Zuora\
\ generates this read-only field if this adjustment is canceled.\n**Character\
\ limit**: 29 **Values**: automatically generated "
format: date-time
type: string
Comment:
description: " Use this field to record comments about the invoice item\
\ adjustment.\n**Character limit**: 255 **Values**: a string of 255 characters\
\ or fewer "
type: string
CreatedById:
description: " The user ID of the person who created the invoice item.\n\
**Character limit**: 32 **Values**: automatically generated "
type: string
CreatedDate:
description: " The date the invoice item was created.\n**Character limit**:\
\ 29 **Values**: automatically generated "
format: date-time
type: string
CustomerName:
description: " The name of the account that owns the associated invoice.\n\
\n**Character limit**: 50\n\n**Values**: inherited from `Account.Name`\n\
\n**Note**: This value changes if `Account.Name` is updated. The values\
\ of `UpdatedById` and `UpdatedDate` for the `InvoiceItemAdjustment` do\
\ not change when `Account.Name` is updated. "
type: string
CustomerNumber:
description: " The unique account number of the customer's account.\n\n\
**Character limit**: 50\n\n**Values**: inherited from `Account.AccountNumber`\n\
\n**Note**: This value changes if `Account.AccountNumber` is updated.\
\ The values of `UpdatedById` and `UpdatedDate` for the `InvoiceItemAdjustment`\
\ do not change when `Account.AccountNumber` is updated. "
type: string
DeferredRevenueAccount:
description: |2-
Records the deferred accounting code in the finance system. This field is in Limited Availability. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). **Character limit**: 100
**Version notes**: WSDL 63.0+
**Values**: If this field is not passed in, a value from InvoiceItem will be used.
type: string
ExcludeItemBillingFromRevenueAccounting:
default: false
description: |
The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items that are generate for the rate plan charge from revenue accounting.
**Version notes**: WSDL 117.0+
**Values**: boolean value
**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.
type: boolean
Id:
description: Object identifier.
type: string
InvoiceId:
description: " The ID of the invoice associated with the adjustment. The\
\ adjustment invoice item is in this invoice. This field is optional if\
\ you specify a value for the `InvoiceNumber` field.\n**Character limit**:\
\ 3 **Values**: a valid invoice ID "
type: string
InvoiceItemName:
description: " The name of the invoice item's charge. This field is required\
\ in the Query call, but is inherited in other calls.\n**Character limit**:\
\ 255 **Values**: inherited from `InvoiceItem.ChargeName` "
type: string
InvoiceNumber:
description: " The unique identification number for the invoice that contains\
\ the invoice item. This field is optional if you specify a value for\
\ the `InvoiceId` field.\n**Character limit**: 32 **Values**: a valid\
\ invoice number "
type: string
ReasonCode:
description: " A code identifying the reason for the transaction. Must be\
\ an existing reason code or empty. If you do not specify a value, Zuora\
\ uses the default reason code.\n**Character limit**: 32 **Values**: a\
\ valid reason code "
type: string
RecognizedRevenueAccount:
description: |2-
Records the recognized accounting code in the finance system. This field is in Limited Availability. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). **Character limit**: 100
**Version notes**: WSDL 63.0+
**Values**: If this field is not passed in, a value from InvoiceItem will be used.
type: string
ReferenceId:
description: " A code to reference an object external to Zuora. For example,\
\ you can use this field to reference a case number in an external system.\n\
**Character limit**: 60 **Values**: a string of 60 characters or fewer "
type: string
ServiceEndDate:
description: " The end date of the service period associated with the invoice\
\ item. Service ends one second before the date in this value.\n\n**Character\
\ limit**: 29 "
format: date
type: string
ServiceStartDate:
description: " The start date of the service period associated with the\
\ invoice item. Service ends one second before the date in this value.\n\
\n**Character limit**: 29 "
format: date
type: string
SourceId:
description: " The ID of the item specified in the SourceType field.\n**Character\
\ limit**: 32 **Values**: a valid invoice item ID or taxation item ID "
type: string
SourceType:
description: " The type of adjustment.\n**Character limit**: 13 **Values**:\
\ InvoiceDetail, Tax "
type: string
Status:
description: " The status of the invoice item adjustment. This field is\
\ required in the Query call, but is automatically generated in other\
\ calls.\n**Character limit**: 9 **Values**: Canceled, Processed "
type: string
TransferredToAccounting:
description: 'Indicates the status of the adjustment''s transfer to an external
accounting system, such as NetSuite.
'
enum:
- Processing
- 'Yes'
- 'No'
- Error
- Ignore
type: string
Type:
description: Indicates whether the adjustment credits or debits the invoice
item amount.
enum:
- Credit
- Charge
type: string
UpdatedById:
description: " The ID of the user who last updated the invoice item.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the invoice item was last updated.\n**Character\
\ limit**: 29 **Values**: automatically generated "
format: date-time
type: string
type: object
- $ref: '#/definitions/InvoiceItemAdjustmentObjectNSFields'
- $ref: '#/definitions/InvoiceItemAdjustmentObjectCustomFields'
ProxyGetInvoicePayment:
properties:
Amount:
description: " The amount of the payment.\n**Character limit**: 16 **Values**:\
\ a valid currency amount "
format: double
type: number
CreatedById:
description: " The user ID of the person who created the invoice payment.\n\
**Character limit**: 32 **V****alues**: automatically generated "
type: string
CreatedDate:
description: " The date when the invoice payment was generated.\n**Character\
\ limit**: 29 **V****alues**: automatically generated "
format: date-time
type: string
Id:
description: Object identifier.
type: string
InvoiceId:
description: " The unique ID of the invoice associated with this invoice payment.\n\
**Character limit**: 32 **Values**: a valid invoice ID "
type: string
PaymentId:
description: " The unique ID of the payment associated with this invoice payment.\n\
**Character limit**: 32 **V****alues**: a valid payment ID "
type: string
RefundAmount:
description: 'Specifies the amount of a refund applied against this InvoicePayment.
**Character limit**: 16 **Values**: automatically generated '
format: double
type: number
UpdatedById:
description: " The ID of the user who last updated the invoice payment.\n\
**Character limit**: 32 **V****alues**: automatically generated "
type: string
UpdatedDate:
description: " The date when the invoice payment was last updated.\n**Character\
\ limit**: 29 **V****alues**: automatically generated "
format: date-time
type: string
type: object
ProxyGetInvoiceSplit:
properties:
CreatedById:
description: 'The ID of the Zuora user who created the InvoiceSplit object.
**Character limit**: 32 **Values**: automatically generated '
type: string
CreatedDate:
description: 'The date when the InvoiceSplit object was created. **Character
limit**: 29 **Values**: automatically generated '
format: date-time
type: string
Id:
description: Object identifier.
type: string
InvoiceId:
description: " The ID of the original invoice that the InvoiceSplit object\
\ splits. This field becomes read-only after the InvoiceSplit object is\
\ created.\n**Character limit**: 32 **Values**: a valid invoice ID "
type: string
UpdatedById:
description: 'The ID of the Zuora user who last updated the invoice split.
**Character limit**: 32 **Values**: automatically generated '
type: string
UpdatedDate:
description: 'The date when the invoice split was last updated. **Values**:
automatically generated '
format: date-time
type: string
type: object
ProxyGetInvoiceSplitItem:
properties:
CreatedById:
description: " The ID of the Zuora user who created the InvoiceSplitItem object.\n\
**Character limit**: 32 **Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the InvoiceSplitItem was created.\n**Values**:\
\ automatically generated "
format: date-time
type: string
Id:
description: Object identifier.
type: string
InvoiceDate:
description: " The generation date of the new split invoice, in `yyyy-mm-dd`\
\ format.\n**Character limit**: 29 "
format: date
type: string
InvoiceId:
description: " The new invoice after the split.\n**Character limit**: 32 **Values**:\
\ automatically generated "
type: string
InvoiceSplitId:
description: " The ID of the invoice split associated with the individual\
\ invoice split item.\n**Character limit**: 32 **Values**: a valid invoice\
\ split ID "
type: string
PaymentTerm:
description: " Indicates when the customer pays the split invoice.\n**Values**:\
\ a valid, active payment term "
type: string
SplitPercentage:
description: |2
Specifies the percentage of the original invoice that you want to be the balance of the split invoice. The total of the SplitPercentage field values for all of the InvoiceSplitItem objects in an InvoiceSplit object must equal 100.
**Values**:
format: double
type: number
UpdatedById:
description: " The ID of the Zuora user who last updated the invoice split.\n\
**Character limit**: 32 **Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the invoice split was last updated.\n**Values**:\
\ automatically generated "
format: date-time
type: string
type: object
ProxyGetPayment:
allOf:
- properties:
AccountId:
description: 'The unique account ID for the customer that the payment is
for.
'
type: string
AccountingCode:
description: 'The accounting code for the payment. Accounting codes group
transactions that contain similar accounting attributes.
'
type: string
Amount:
description: 'The amount of the payment.
'
format: double
type: number
AppliedAmount:
description: |
The applied amount of the payment.
**Note**: This field is only available if you have the Invoice Settlement feature enabled.
format: double
type: number
AppliedCreditBalanceAmount:
description: |
If you have the Invoice Settlement feature disabled, the value of this field is the amount of the payment to apply to a credit balance.
If you have the Invoice Settlement feature enabled, the value of this field returned in the response is `0` for the payments that are created after the enablement.
format: double
type: number
AuthTransactionId:
description: "The authorization transaction ID from the payment gateway.\
\ \n"
type: string
BankIdentificationNumber:
description: "The first six or eight digits of the credit card or debit\
\ card used for the payment, when applicable. \n"
type: string
CancelledOn:
description: 'The date and time when the payment was canceled.
'
format: date-time
type: string
Comment:
description: 'Additional information related to the payment.
'
type: string
CreatedById:
description: 'The ID of the Zuora user who created the payment.
'
type: string
CreatedDate:
description: 'The date and time when the payment was created.
'
format: date-time
type: string
EffectiveDate:
description: 'The date when the payment takes effect.
'
format: date
type: string
Gateway:
description: "The name of the gateway instance that processes the payment.\
\ \n"
type: string
GatewayOrderId:
description: 'A merchant-specified natural key value that can be passed
to the electronic payment gateway when a payment is created. If not specified,
the payment number will be passed in instead.
'
type: string
GatewayResponse:
description: 'The message returned from the payment gateway for the payment.
This message is gateway-dependent.
'
type: string
GatewayResponseCode:
description: 'The code returned from the payment gateway for the payment.
This code is gateway-dependent.
'
type: string
GatewayState:
description: 'The status of the payment in the gateway; use for reconciliation.
'
enum:
- MarkedForSubmission
- Submitted
- Settled
- NotSubmitted
- FailedToSettle
type: string
Id:
description: 'The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352.
'
type: string
MarkedForSubmissionOn:
description: "The date and time when a payment was marked and waiting for\
\ batch submission to the payment process. \n"
format: date-time
type: string
PaymentMethodId:
description: "The ID of the payment method used for the payment. \n"
type: string
PaymentMethodSnapshotId:
description: 'The unique ID of the payment method snapshot which is a copy
of the particular payment method used in a transaction.
'
type: string
PaymentNumber:
description: 'The unique identification number of the payment. For example,
P-00000028.
'
type: string
ReferenceId:
description: 'The transaction ID returned by the payment gateway. Use this
field to reconcile payments between your gateway and Zuora Payments.
'
type: string
RefundAmount:
description: 'The amount of the payment that is refunded. The value of this
field is `0` if no refund is made against the payment.
'
format: double
type: number
SecondPaymentReferenceId:
description: 'The transaction ID returned by the payment gateway if there
is an additional transaction for the payment. Use this field to reconcile
payments between your gateway and Zuora Payments.
'
type: string
SettledOn:
description: 'The date and time when the payment was settled in the payment
processor. This field is used by the Spectrum gateway only and not applicable
to other gateways.
'
format: date-time
type: string
SoftDescriptor:
description: "A payment gateway-specific field that maps to Zuora for the\
\ gateways, Orbital, Vantiv and Verifi. \n"
type: string
SoftDescriptorPhone:
description: 'A payment gateway-specific field that maps to Zuora for the
gateways, Orbital, Vantiv and Verifi.
'
type: string
Source:
description: 'How the payment was created, whether through the API, manually,
import, or payment run.
'
enum:
- PaymentRun
- Import
- Manually
- API
type: string
SourceName:
description: 'The name of the source. The value is a Payment Run number
or a file name.
'
type: string
Status:
description: |
The status of the payment in Zuora. The value depends on the type of payments.
- If you have the Invoice Settlement feature disabled, for electronic payments, the status can be `Processed`, `Processing`, `Error`, or `Voided`. For external payments, the status can be `Processed` or `Canceled`.
- If you have the Invoice Settlement feature enabled, for electronic payments, the status can be `Processed`, `Processing`, `Error`, or `Canceled`. For external payments, the status can be `Processed` or `Canceled`.
enum:
- Processed
- Error
- Voided
- Canceled
type: string
SubmittedOn:
description: 'The date and time when the payment was submitted.
'
format: date-time
type: string
TransferredToAccounting:
description: 'Indicates if the payment was transferred to an external accounting
system. Use this field for integration with accounting systems, such as
NetSuite.
'
enum:
- Processing
- 'Yes'
- Error
- Ignore
type: string
Type:
description: 'The type of the payment, whether the payment is external or
electronic.
'
enum:
- External
- Electronic
type: string
UnappliedAmount:
description: |
The unapplied amount of the payment.
**Note**: This field is only available if you have the Invoice Settlement feature enabled.
format: double
type: number
UpdatedById:
description: 'The ID of the Zuora user who last updated the payment.
'
type: string
UpdatedDate:
description: 'The date and time when the payment was last updated.
'
format: date-time
type: string
type: object
- $ref: '#/definitions/PaymentObjectNSFields'
- $ref: '#/definitions/PaymentObjectCustomFields'
ProxyGetPaymentMethod:
properties:
AccountId:
description: ' The ID of the customer account associated with this payment
method. This field is not required for the account ID. '
type: string
AchAbaCode:
description: " The nine-digit routing number or ABA number used by banks.\
\ Use this field for ACH payment methods.\n**Character limit**: 9 **Values**:\
\ a string of 9 characters or fewer "
type: string
AchAccountName:
description: " The name of the account holder, which can be either a person\
\ or a company. Use this field for ACH payment methods.\n**Character limit**:\
\ 70 **Values**: a string of 70 characters or fewer "
type: string
AchAccountNumberMask:
description: " This is a masked displayable version of the ACH account number,\
\ used for security purposes. For example: `XXXXXXXXX54321`. Use this field\
\ for ACH payment methods.\n**Character limit**: 32 **Values**: automatically\
\ generated "
type: string
AchAccountType:
description: |2
The type of bank account associated with the ACH payment. Use this field for ACH payment methods.
When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably.
**Character limit**: 16 **Values**:
- `BusinessChecking`
- `BusinnessSaving`
- `Checking`
- `Saving`
type: string
AchAddress1:
description: " Line 1 for the ACH address. Required on create for the Vantiv\
\ payment gateway. Optional for other gateways.\n**Character limit:** **Values:**\
\ an address "
type: string
AchAddress2:
description: " Line 2 for the ACH address. Required on create for the Vantiv\
\ payment gateway. Optional for other gateways.\n**Character limit:** **Values:**\
\ an address "
type: string
AchBankName:
description: " The name of the bank where the ACH payment account is held.\
\ Use this field for ACH payment methods.\nWhen creating an ACH payment\
\ method on Adyen, this field is required by Zuora but it is not required\
\ by Adyen. To create the ACH payment method successfully, specify a real\
\ value for this field if you can. If it is not possible to get the real\
\ value for it, specify a dummy value.\n**Character limit**: 70 **Values**:\
\ a string of 70 characters or fewer "
type: string
Active:
description: " Specifies whether a payment method is available in Zuora. This\
\ field is used to indicate if a payment method is loaded by the system\
\ or created by the customer.\n- `true`: System loaded payment method.\n\
- `false`: Customer created payment method.\n\nThe default value is `false`.\n\
**Character limit**: 5 **Values**: `true`, `false` "
type: boolean
BankBranchCode:
description: " The branch code of the bank used for direct debit.\n**Character\
\ limit**: 10 **Values**: string of 10 characters or fewer "
type: string
BankCheckDigit:
description: 'The check digit in the international bank account number, which
confirms the validity of the account. Use this field for direct debit payment
methods. **Character limit**: 4 **Values**: string of 4 characters or fewer '
type: string
BankCity:
description: " The city of the direct debit bank. Use this field for direct\
\ debit payment methods.\n**Character limit**:70 **Values**: string of\
\ 70 characters or fewer "
type: string
BankCode:
description: " The sort code or number that identifies the bank. This is also\
\ known as the sort code. This field is required for direct debit payment\
\ methods.\n**Character limit**: 18 **Values**: string of 18 characters\
\ or fewer "
type: string
BankIdentificationNumber:
description: " The first six or eight digits of the payment method's number,\
\ such as the credit card number or account number. Banks use this number\
\ to identify a payment method.\n**Character limit**: 8 **Values**: string\
\ of 8 characters or fewer "
type: string
BankName:
description: " The name of the direct debit bank. Use this field for direct\
\ debit payment methods.\n**Character limit**:80 **Values**: string of\
\ 80 characters or fewer "
type: string
BankPostalCode:
description: " The zip code or postal code of the direct debit bank. Use this\
\ field for direct debit payment methods.\n**Character limit**:20 **Values**:\
\ string of 20 characters or fewer "
type: string
BankStreetName:
description: " The name of the street of the direct debit bank. Use this field\
\ for direct debit payment methods.\n**Character limit**:60 **Values**:\
\ string of 60 characters or fewer "
type: string
BankStreetNumber:
description: " The number of the direct debit bank. Use this field for direct\
\ debit payment methods.\n**Character limit**:10 **Values**: string of\
\ 10 characters or fewer "
type: string
BankTransferAccountName:
description: " The name on the customer's bank account. Use this field for\
\ bank transfer payment methods.\n**Character limit**: 60 **Values**: string\
\ of 60 characters or fewer "
type: string
BankTransferAccountNumber:
description: |
The number of the customer's bank account. Use this field for bank transfer payment methods.
**Character limit**: 30
**Values**: a string of 30 characters or fewer
type: string
BankTransferAccountNumberMask:
description: " This is a masked displayable version of the bank account number,\
\ used for security purposes. For example: `XXXXXXXXX54321`.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
BankTransferAccountType:
description: " The type of the customer's bank account. Use this field for\
\ direct debit payment methods.\n**Character limit**: 11 **Values**: `DirectDebit` "
type: string
BankTransferType:
description: 'The type of direct debit transfer.
'
maxLength: 20
type: string
BusinessIdentificationCode:
description: " The business identification code for Swiss direct payment methods\
\ that use the Global Collect payment gateway. Use this field only for direct\
\ debit payments in Switzerland with Global Collect.\n**Character limit**:\
\ 11 **Values**: string of 11 characters or fewer "
type: string
City:
description: " The city of the customer's address. Use this field for direct\
\ debit payment methods.\n**Character limit**:80 **Values**: string of\
\ 80 characters or fewer "
type: string
CompanyName:
description: 'The name of the company.
'
type: string
Country:
description: " The two-letter country code of the customer's address. Use\
\ this field for bank transfer payment methods.\n**Character limit**: 2\
\ **Values**: a valid country code "
type: string
CreatedById:
description: " The user ID of the person who created the `PaymentMethod` object\
\ when there is a login user in the user session. In Hosted Payment Method\
\ and Zuora Checkout pages, this field is set to 3 as there is no login\
\ user to initiate a user session.\n**Character limit**: 32 **Values**:\
\ automatically generated "
type: string
CreatedDate:
description: " The date when the `PaymentMethod` object was created in the\
\ Zuora system.\n**Character limit**: 29 **Values**: automatically generated "
format: date-time
type: string
CreditCardAddress1:
description: " The first line of the card holder's address, which is often\
\ a street address or business name. Use this field for credit card and\
\ direct debit payment methods.\n**Character limit**: 255 **Values**: a\
\ string of 255 characters or fewer "
type: string
CreditCardAddress2:
description: " The second line of the card holder's address. Use this field\
\ for credit card and direct debit payment methods.\n**Character limit**:\
\ 255 **Values**: a string of 255 characters or fewer "
type: string
CreditCardCity:
description: ' The city of the card holder''s address. Use this field for
credit card and direct debit payment methods **Character limit**: 40 **Values**:
a string of 40 characters or fewer '
type: string
CreditCardCountry:
description: ' The country of the card holder''s address. '
type: string
CreditCardExpirationMonth:
description: " The expiration month of the credit card or debit card. Use\
\ this field for credit card and direct debit payment methods.\n**Character\
\ limit**: 2 **Values**: a two-digit number, 01 - 12 "
format: int32
type: integer
CreditCardExpirationYear:
description: " The expiration month of the credit card or debit card. Use\
\ this field for credit card and direct debit payment methods.\n**Character\
\ limit**: 4 **Values**: a four-digit number "
format: int32
type: integer
CreditCardHolderName:
description: " The full name of the card holder. Use this field for credit\
\ card and direct debit payment methods.\n**Character limit**: 50 **Values**:\
\ a string of 50 characters or fewer "
type: string
CreditCardMaskNumber:
description: " A masked version of the credit or debit card number.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
CreditCardPostalCode:
description: " The billing address's zip code. This field is required only\
\ when you define a debit card or credit card payment.\n**Character limit**:\
\ 20 **Values**: a string of 20 characters or fewer "
type: string
CreditCardState:
description: ' The billing address''s state. Use this field is if the `CreditCardCountry`
value is either Canada or the US. State names must be spelled in full. '
type: string
CreditCardType:
description: "The type of the credit card.\n \nPossible values include\
\ `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`.\
\ For more information about credit card types supported by different payment\
\ gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).\n"
type: string
DeviceSessionId:
description: " The session ID of the user when the `PaymentMethod` was created\
\ or updated. Some gateways use this field for fraud prevention. If this\
\ field is passed to Zuora, then Zuora passes this field to supported gateways.\
\ Currently only Verifi supports this field.\n**Character limit**: 255 "
type: string
Email:
description: " An email address for the payment method in addition to the\
\ bill to contact email address.\n**Character limit**: 80 **Values**: a\
\ string of 80 characters or fewer "
type: string
ExistingMandate:
description: " Indicates if the customer has an existing mandate or a new\
\ mandate. A mandate is a signed authorization for UK and NL customers.\
\ When you are migrating mandates from another system, be sure to set this\
\ field correctly. If you indicate that a new mandate is an existing mandate\
\ or vice-versa, then transactions fail. This field is used only for the\
\ direct debit payment method.\n**Character limit**: 3 **Values**: `Yes`\
\ or `No` "
type: string
FirstName:
description: " The customer's first name. This field is used only for the\
\ direct debit payment method.\n**Character limit**: 30 **Values**: a string\
\ of 30 characters or fewer "
type: string
IBAN:
description: " The International Bank Account Number. This field is used only\
\ for the direct debit payment method.\n**Character limit**: 42 **Values**:\
\ a string of 42 characters or fewer "
type: string
IPAddress:
description: ' The IPv4 or IPv6 information of the user when the payment method
was created or updated. Gateways use this field for fraud prevention. If
this field is passed to Zuora, then Zuora passes this field to supported
gateways. If the IP address length is beyond 45 characters, a validation
error occurs. '
type: string
Id:
description: Object identifier.
type: string
IdentityNumber:
description: "The unique identity number of the customer account. \n"
type: string
IsCompany:
description: 'Whether the customer account is a company.
'
type: boolean
LastFailedSaleTransactionDate:
description: " The date of the last failed attempt to collect payment with\
\ this payment method.\n**Character limit**: 29 **Values**: automatically\
\ generated "
format: date-time
type: string
LastName:
description: " The customer's last name. This field is used only for the direct\
\ debit payment method.\n**Character limit**: 70 **Values**: a string of\
\ 70 characters or fewer "
type: string
LastTransactionDateTime:
description: " The date of the most recent transaction.\n**Character limit**:\
\ 29 **Values**: a valid date and time value "
format: date-time
type: string
LastTransactionStatus:
description: " The status of the most recent transaction.\n**Character limit**:\
\ 39 **Values**: automatically generated "
type: string
MandateCreationDate:
description: " The date when the mandate was created, in `yyyy-mm-dd` format.\
\ A mandate is a signed authorization for UK and NL customers. This field\
\ is used only for the direct debit payment method.\n**Character limit**:\
\ 29 "
format: date
type: string
MandateID:
description: " The ID of the mandate. A mandate is a signed authorization\
\ for UK and NL customers. This field is used only for the direct debit\
\ payment method.\n**Character limit**: 36 **Values**: a string of 36 characters\
\ or fewer "
type: string
MandateReceived:
description: " Indicates if the mandate was received. A mandate is a signed\
\ authorization for UK and NL customers. This field is used only for the\
\ direct debit payment method.\n**Character limit**: 3 **Values**: `Yes`\
\ or `No `(case-sensitive) "
type: string
MandateUpdateDate:
description: " The date when the mandate was last updated, in `yyyy-mm-dd`\
\ format. A mandate is a signed authorization for UK and NL customers. This\
\ field is used only for the direct debit payment method.\n**Character limit**:\
\ 29 "
format: date
type: string
MaxConsecutivePaymentFailures:
description: " Specifies the number of allowable consecutive failures Zuora\
\ attempts with the payment method before stopping.\n**Values**: a valid\
\ number "
type: integer
Name:
description: The name of the payment method.
type: string
NumConsecutiveFailures:
description: "The number of consecutive failed payments for this payment method.\
\ It is reset to `0` upon successful payment. \n"
format: int32
maximum: 100
minimum: 0
type: integer
PaymentMethodStatus:
description: |2
This field is used to indicate the status of the payment method created within an account. It is set to `Active` on creation.
**Character limit**: 6 **Values**: `Active` or `Closed`
type: string
PaymentRetryWindow:
description: " The retry interval setting, which prevents making a payment\
\ attempt if the last failed attempt was within the last specified number\
\ of hours. This field is required if the `UseDefaultRetryRule` field value\
\ is set to `false`.\n**Character limit**: 4 **Values**: a whole number\
\ between 1 and 1000, exclusive "
type: integer
PaypalBaid:
description: " The PayPal billing agreement ID, which is a contract between\
\ two PayPal accounts. Typically, the selling party initiates a request\
\ to create a BAID, and sends it to buying party for acceptance. The seller\
\ can keep track of the BAID and use it for future charges against the buyer.\
\ This field is required when defining a PayPal payment method.\n**Character\
\ limit**: 64 **Values**: a string of 64 characters or fewer "
type: string
PaypalEmail:
description: " The email address associated with the account holder's PayPal\
\ account or of the PayPal account of the person paying for the service.\
\ This field is required only when you define a PayPal payment method.\n\
**Character limit**: 80 **Values**: a string of 80 characters or fewer "
type: string
PaypalPreapprovalKey:
description: " PayPal's Adaptive Payments API key. Zuora does not create this\
\ key, nor does it call PayPal to generate it. You must use PayPal's Adaptive\
\ Payments' API to generate this key, and then pass it to Zuora. Zuora uses\
\ this key to authorize future payments to PayPal's Adaptive Payments API.\
\ This field is required when you use PayPal Adaptive Payments gateway.\n\
**Character limit**: 32 **Values**: a valid PayPal Adaptive Payment pre-approval\
\ key "
type: string
PaypalType:
description: " Specifies the PayPal gateway: PayFlow Pro (Express Checkout)\
\ or Adaptive Payments. This field is required when you use PayPal Adaptive\
\ Payments or Payflow Pro (Express Checkout) gateways.\n**Character limit**:\
\ 32 **Values**: `ExpressCheckout` or `AdaptivePayments` "
type: string
Phone:
description: " The phone number that the account holder registered with the\
\ bank. This field is used for credit card validation when passing to a\
\ gateway.\n**Character limit**: 40 **Values**: a string of 40 characters\
\ or fewer "
type: string
PostalCode:
description: " The zip code of the customer's address. This field is used\
\ only for the direct debit payment method.\n**Character limit**: 20 **Values**:\
\ a string of 20 characters or fewer "
type: string
SecondTokenId:
description: ' A gateway unique identifier that replaces sensitive payment
method data. `SecondTokenId` is conditionally required only when `TokenId`
is being used to represent a gateway customer profile. `SecondTokenId` is
used in the CC Reference Transaction payment method. **Character limit**:
64 **Values**: a string of 64 characters or fewer '
type: string
State:
description: " The state of the customer's address. This field is used only\
\ for the direct debit payment method.\n**Character limit**: 70 **Values**:\
\ a string of 70 characters or fewer "
type: string
StreetName:
description: " The street name of the customer's address. This field is used\
\ only for the direct debit payment method.\n**Character limit**: 100 **Values**:\
\ a string of 100 characters or fewer "
type: string
StreetNumber:
description: " The street number of the customer's address. This field is\
\ used only for the direct debit payment method.\n**Character limit**: 30\
\ **Values**: a string of 30 characters or fewer "
type: string
TokenId:
description: " A gateway unique identifier that replaces sensitive payment\
\ method data or represents a gateway's unique customer profile. `TokenId`\
\ is required for the CC Reference Transaction payment method.\n**Character\
\ limit**: 255 **Values**: a string of 255 characters or fewer "
type: string
TotalNumberOfErrorPayments:
description: " The number of error payments that used this payment method.\n\
**Character limit**: **Values**: automatically generated "
format: int32
type: integer
TotalNumberOfProcessedPayments:
description: " The number of successful payments that used this payment method.\n\
**Character limit**: **Values**: automatically generated "
format: int32
type: integer
Type:
description: 'The type of payment method. '
enum:
- ACH
- ApplePay
- BankTransfer
- Cash
- Check
- CreditCard
- CreditCardReferenceTransaction
- DebitCard
- Other
- PayPal
- WireTransfer
type: string
UpdatedById:
description: " The ID of the user who last updated the payment method.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the payment method was last updated.\n**Character\
\ limit**: 29 **Values**: automatically generated "
format: date-time
type: string
UseDefaultRetryRule:
description: " Determines whether to use the default retry rules configured\
\ in the Zuora Payments settings. Set this to `true` to use the default\
\ retry rules. Set this to `false` to set the specific rules for this payment\
\ method. If you set this value to `false`, then the fields, `PaymentRetryWindow`\
\ and `MaxConsecutivePaymentFailures`, are required.\n**Character limit**:\
\ 5 **Values**: `t``rue`, `false` "
type: boolean
type: object
ProxyGetProductFeature:
allOf:
- properties:
CreatedById:
description: 'The ID of the Zuora user who created the Account object. **Character
limit**: 32 **Values**: automatically generated '
type: string
CreatedDate:
description: 'The date when the Account object was created. **Character
limit**: 29 **Values**: automatically generated '
format: date-time
type: string
FeatureId:
description: " Internal Zuora ID of the product feature. This field is not\
\ editable.\n**Character limit**: 32 **Values**: a string of 32 characters\
\ or fewer "
type: string
Id:
description: Object identifier.
type: string
ProductId:
description: " Id of the product to which the feature belongs. This field\
\ is not editable.\n**Character limit**: 32 **Values**: a string of 32\
\ characters or fewer "
type: string
UpdatedById:
description: 'The ID of the user who last updated the account. **Character
limit**: 32 **Values**: automatically generated '
type: string
UpdatedDate:
description: 'The date when the account was last updated. **Character limit**:
29 **Values**: automatically generated '
format: date-time
type: string
type: object
- $ref: '#/definitions/ProductFeatureObjectCustomFields'
ProxyGetRatePlan:
allOf:
- properties:
AmendmentId:
description: " The ID of the amendment associated with the rate plan. This\
\ field only applies to amendment rate plans.\n**Character limit**: 32\
\ **Values**: a valid amendment ID "
type: string
AmendmentType:
description: 'The type of amendment associated with the rate plan. This
field only applies to amendment rate plans. '
type: string
CreatedById:
description: 'The ID of the Zuora user who created the RatePlan object.
**Character limit**: 32 **Values**: automatically generated '
type: string
CreatedDate:
description: 'The date when the `RatePlan` object was last updated. **Character
limit**: 29 **Values**: automatically generated '
format: date-time
type: string
ExternallyManagedPlanId:
description: 'The unique identifier for the rate plan purchased on a third-party
store. This field is used to represent a subscription rate plan created
through third-party stores.
'
type: string
Id:
description: Object identifier.
type: string
Name:
description: "The name of the rate plan.\n\n**Values**: inherited from `ProductRatePlan.Name` "
type: string
OriginalRatePlanId:
description: |
The original ID of the subscription rate plan, which is the ID of the subscription rate plan in the version-1 subscription.
**Character limit**: 32 **Values**: a valid subscription rate plan ID
type: string
SubscriptionId:
description: 'The ID of the subscription that the rate plan belongs to.
**Character limit**: 32 **Values**: a valid subscription ID '
type: string
UpdatedById:
description: " The ID of the user who last updated the rate plan.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the rate plan was last updated.\n**Character\
\ limit**: 29 **Values**: automatically generated "
format: date-time
type: string
type: object
- $ref: '#/definitions/RatePlanObjectCustomFields'
ProxyGetRatePlanCharge:
allOf:
- properties:
AccountingCode:
description: "The accounting code for the charge. Accounting codes group\
\ transactions that contain similar accounting attributes.\n\n**Character\
\ limit**: 100\n\n**Values**: inherited from `ProductRatePlanCharge.AccountingCode`\n\
\n**Note**: This value changes if `ProductRatePlanCharge.AccountingCode`\
\ is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge`\
\ do not change when `ProductRatePlanCharge.AccountingCode` is updated. "
type: string
ApplyDiscountTo:
description: ' Specifies the type of charges a specific discount applies
to. **Character limit**: 21 **Values**: inherited from `ProductRatePlanCharge.ApplyDiscountTo` '
type: string
BillCycleDay:
description: " Indicates the charge's billing cycle day (BCD), which is\
\ when bill runs generate invoices for charges associated with the product\
\ rate plan charge or the account.\n**Character limit**: 2 **Values**:\
\ inherited from `ProductRatePlanCharge.BillCycleDay` "
format: int32
type: integer
BillCycleType:
description: " Specifies how to determine the billing day for the charge.\n\
**Character limit**: 20 **Values**: inherited from `ProductRatePlanCharge.BillCycleType`\
\ **Note:** You can override the value inherited from the Product Rate\
\ Plan Charge, but only when creating a new subscription or a New Product\
\ amendment. "
type: string
BillingPeriod:
description: " Allows billing period to be overridden on rate plan charge.\n\
****Values**: **inherited from `ProductRatePlanCharge.BillingPeriod` **Note:**\
\ You can override the value inherited from the Product Rate Plan Charge,\
\ but only when creating a new subscription or a New Product amendment. "
type: string
BillingPeriodAlignment:
description: " Aligns charges within the same subscription if multiple charges\
\ begin on different dates.\n**Character limit**: 24 **Values**: inherited\
\ from `ProductRatePlanCharge.BillingPeriodAlignment` "
type: string
BillingTiming:
description: |2+
The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types.
**Character limit**: **Values**: one of the following:
- `In Advance`
- `In Arrears`
**Note:** You can override the value inherited from the Product Rate Plan Charge when a subscription has a recurring charge type.
type: string
ChargeModel:
description: " Determines how to evaluate charges. Charge models must be\
\ individually activated in the web-based UI.\n**Character limit**: 29\
\ **Values**: inherited from `ProductRatePlanCharge.ChargeModel` "
type: string
ChargeNumber:
description: |2
A unique number that identifies the charge. This number is returned as a string.
**Character limit**: 50 **Values**: one of the following:
- automatically generated if left null
- a unique number of 50 characters or fewer
type: string
ChargeType:
description: " Specifies the type of charge.\n**Character limit**: 9 **Values**:\
\ inherited from `ProductRatePlanCharge.ChargeType` "
type: string
ChargedThroughDate:
description: " The date through which a customer has been billed for the\
\ charge.\n**Character limit**: 29 **Values**: automatically generated "
format: date
type: string
CreatedById:
description: 'The ID of the Zuora user who created the `RatePlanCharge`
object. **Character limit**: 32 **Values**: automatically generated '
type: string
CreatedDate:
description: " The date when the `RatePlanCharge` object was created.\n\
**Character limit**: 29 **Values**: automatically generated "
format: date-time
type: string
DMRC:
description: 'A delta monthly recurring charge is the change in monthly
recurring revenue caused by an amendment or a new subscription. **Character
limit**: 16 **Values**: automatically generated '
format: double
type: number
DTCV:
description: " After an Amendment, the change in the total contract value\
\ (TCV) amount for this charge, compared with its previous value.\n**Character\
\ limit**: 16 **Values**: automatically generated "
format: double
type: number
Description:
description: " A description of the charge.\n**Character limit**: 500 **Values**:\
\ inherited from `ProductRatePlanCharge.Description` "
type: string
DiscountLevel:
description: 'Specifies if the discount applies to just the product rate
plan, the entire subscription, or to any activity in the account. **Character
limit**: 12 **Values**: inherited from `ProductRatePlanCharge.DiscountLevel` '
type: string
EffectiveEndDate:
description: " The date when the segmented charge ends or ended.\n**Character\
\ limit**: 16 **Values**: automatically generated "
format: date
type: string
EffectiveStartDate:
description: " The date when the segmented charge starts or started.\n**Character\
\ limit**: 16 **Values**: automatically generated "
format: date
type: string
EndDateCondition:
description: " Defines when the charge ends after the charge trigger date.\
\ This field can be updated when **Status** is `Draft`.\n**Values**: one\
\ of the following:\n\n- `SubscriptionEnd`: The charge ends on the subscription\
\ end date after the charge trigger date. This is the default value.\n\
- `FixedPeriod`: The charge ends after a specified period based on the\
\ trigger date of the charge. If you set this field to `FixedPeriod`,\
\ you must specify the length of the period and a period type by defining\
\ the `UpToPeriods` and `UpToPeriodsType` fields.\n- `SpecificEndDate`:\
\ The specific date on which the charge ends. If you set this field to\
\ `SpecificEndDate`, you must specify the specific date by defining the\
\ `SpecificEndDate` field.\n\n**Note**: If the subscription ends before\
\ the charge end date, the charge ends when the subscription ends. But\
\ if the subscription end date is subsequently changed through a Renewal,\
\ or Terms and Conditions amendment, the charge will end on the charge\
\ end date. "
type: string
ExcludeItemBillingFromRevenueAccounting:
description: "The flag to exclude rate plan charge related invoice items,\
\ invoice item adjustments, credit memo items, and debit memo items from\
\ revenue accounting.\n\n**Note**: To use this field, you must set the\
\ `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise,\
\ an error occurs.\n\n**Note**: This field is only available if you have\
\ the Billing - Revenue Integration feature enabled. \n"
type: boolean
ExcludeItemBookingFromRevenueAccounting:
description: "The flag to exclude rate plan charges from revenue accounting.\n\
\n**Note**: To use this field, you must set the `X-Zuora-WSDL-Version`\
\ request header to `115` or later. Otherwise, an error occurs.\n\n**Note**:\
\ This field is only available if you have the Billing - Revenue Integration\
\ feature enabled. \n"
type: boolean
Id:
description: Object identifier.
type: string
IsLastSegment:
description: 'Indicates if the segment of the rate plan charge is the most
recent segment. **Character limit**: 5 **Values**: automatically generated:
`true`, `false` '
type: boolean
ListPriceBase:
description: |
The list price base for the product rate plan charge.
enum:
- Per Month
- Per Billing Period
- Per Week
- Per Year
- Per Specific Months
type: string
MRR:
description: 'Monthly recurring revenue (MRR) is the amount of recurring
charges in a given month. The MRR calculation doesn''t include one-time
charges nor usage charges. **Character limit**: 16 **Values**: automatically
generated '
format: double
type: number
Name:
description: 'The name of the rate plan charge. **Character limit**: 100
**Values**: automatically generated '
type: string
NumberOfPeriods:
description: 'Specifies the number of periods to use when calculating charges
in an overage smoothing charge model. **Character limit**: 5 **Values**:
inherited from `ProductRatePlanCharge.NumberOfPeriod` '
format: int64
type: integer
OriginalId:
description: 'The original ID of the rate plan charge. **Character limit**:
32 **Values**: automatically generated '
type: string
OverageCalculationOption:
description: 'Determines when to calculate overage charges. If the value
of the SmoothingMode field is null (not specified and not inherited from
ProductRatePlanCharge.SmoothingMode), the value of this field is ignored.
**Character limit**: 20 **Values**: inherited from `ProductRatePlanCharge.OverageCalculationOption` '
type: string
OverageUnusedUnitsCreditOption:
description: " Determines whether to credit the customer with unused units\
\ of usage.\n**Character limit**: 20 **Values**: inherited from `ProductRatePlanCharge.OverageUnusedUnitsCreditOption` "
type: string
PriceChangeOption:
description: |2
Applies an automatic price change when a termed subscription is renewed.
**Character limit**: **Values**: one of the following:
- `NoChange` (default)
- `SpecificPercentageValue`
- `UseLatestProductCatalogPricing`
type: string
PriceIncreasePercentage:
description: " Specifies the percentage to increase or decrease the price\
\ of renewed subscriptions.\n**Character limit**: 16 **Values**: a decimal\
\ value between -100 and 100 "
format: double
type: number
ProcessedThroughDate:
description: " The date until when charges have been processed. When billing\
\ in arrears, such as usage, this field value is the the same as the `ChargedThroughDate`\
\ value. This date is the earliest date when a charge can be amended.\n\
**Character limit**: 29 **Values**: automatically generated "
format: date
type: string
Quantity:
description: " The default quantity of units, such as the number of authors\
\ in a hosted wiki service. Valid for all charge models except for Flat\
\ Fee pricing.\n**Character limit**: 16 **Values**: a valid quantity value "
format: double
type: number
RatePlanId:
description: " The ID of the rate plan associated with the rate plan charge.\n\
**Character limit**: 32 **Values**: inherited from `RatePlan.Id` "
type: string
RatingGroup:
description: "A rating group based on which usage records are rated. Only\
\ applicable to Usage charges.\n\nPossible values:\n\n- `ByBillingPeriod`:\
\ The rating is based on all the usages in a billing period.\n- `ByUsageStartDate`:\
\ The rating is based on all the usages on the same usage start date.\
\ \n- `ByUsageRecord`: The rating is based on each usage record.\n- `ByUsageUpload`:\
\ The rating is based on all the usages in a uploaded usage file (`.xls`\
\ or `.csv`).\n- `ByGroupId`: The rating is based on all the usages in\
\ a custom group.\n\nFor more information, see [Usage rating by group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group).\n"
enum:
- ByBillingPeriod
- ByUsageStartDate
- ByUsageRecord
- ByUsageUpload
- ByGroupId
type: string
RevRecCode:
description: " Associates this product rate plan charge with a specific\
\ revenue recognition code.\n\n**Character limit**: 70\n\n**Values**:\
\ inherited from `ProductRatePlanCharge.RevRecCode` or a valid revenue\
\ recognition code\n\n**Note**: Unless overridden, this value changes\
\ if `ProductRatePlanCharge.RevRecCode` is updated. The values of `UpdatedById`\
\ and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevRecCode`\
\ is updated. "
type: string
RevRecTriggerCondition:
description: " Specifies when revenue recognition begins.\n\n**Character\
\ limit**: 22\n\n**Values**: inherited from `ProductRatePlanCharge.RevRecTriggerCondition`\
\ or one of the following:\n\n- `ContractEffectiveDate`\n\n- `ServiceActivationDate`\n\
\n- `CustomerAcceptanceDate`\n\nNote: Unless overridden, this value changes\
\ if `ProductRatePlanCharge.RevRecTriggerCondition` is updated. The values\
\ of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change\
\ when `ProductRatePlanCharge.RevRecTriggerCondition` is updated. "
type: string
RevenueRecognitionRuleName:
description: " Specifies the Revenue Recognition Rule that you want the\
\ Rate Plan Charge to use. This field can be updated when **Status** is\
\ `Draft`. By default, the Revenue Recognition Rule is inherited from\
\ the Product Rate Plan Charge. For Amend calls, you can use this field\
\ only for NewProduct amendments. For Update calls, you can use this field\
\ only to update subscriptions in draft status. Note that if you use this\
\ field to specify a Revenue Recognition Rule for the Rate Plan Charge,\
\ the rule will remain as specified even if you later change the rule\
\ used by the corresponding Product Rate Plan Charge.\n\n**Character limit**:\
\ n/a\n\n**Values**: inherited from `ProductRatePlanCharge.RevenueRecognitionRuleName`\
\ or the name of an active Revenue Recognition Rule\n\n**Note**: Unless\
\ overridden, this value changes if `ProductRatePlanCharge.RevenueRecognitionRuleName`\
\ is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge`\
\ do not change when `ProductRatePlanCharge.RevenueRecognitionRuleName`\
\ is updated. "
type: string
RolloverBalance:
description: |
Specifies the number of units of measure (UOM) rolled over from previous periods. The value of this field is the rollover balance for the corresponding account.
This field is applicable only to usage charges with overage models.
**Note**:
- You cannot query or filter this field with other fields in a single query.
- To query or filter this field, you must specify and only specify the rate plan charge Id in the condition.
- You cannot use this field in the query or filter condition.
maxLength: 16
type: number
Segment:
description: " The identifying number of the subscription rate plan segment.\
\ Segments are numbered sequentially, starting with 1.\n**Character limit**:\
\ 2 **Values**: automatically generated "
format: int32
type: integer
SpecificBillingPeriod:
description: " Customizes the number of months or weeks for the charges\
\ billing period. This field is required if you set the value of the BillingPeriod\
\ field to `Specific Months` or `Specific Weeks`.\n**Character limit**:\
\ 5 **Values**: inherited from `ProductRatePlanCharge.BillingPeriod` **Note:**\
\ You can override the value inherited from the Product Rate Plan Charge,\
\ but only when creating a new subscription or a New Product amendment. "
format: int64
type: integer
SpecificEndDate:
description: |2
The specific date on which the charge ends, in `yyyy-mm-dd` format.
**Character limit**: 29 **Note**:
- This field is only applicable when the `EndDateCondition` field is set to `SpecificEndDate`.
- If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date.
format: date
type: string
SpecificListPriceBase:
description: 'The number of months for the list price base of the charge.
The value of this field is `null` if you do not set the value of the `ListPriceBase`
field to `Per Specific Months`.
**Note**:
- This field is available only if you have the Annual List Price feature enabled.
- The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
'
TCV:
description: " The total contract value (TCV) is the value of a single rate\
\ plan charge in a subscription over the lifetime of the subscription.\
\ This value does not represent all charges on the subscription. The TCV\
\ includes recurring charges and one-time charges, but it doesn't include\
\ usage charge.\n**Character limit**: 16 **Values**: automatically generated "
format: double
type: number
TriggerDate:
description: " The date when the charge becomes effective and billing begins,\
\ in `yyyy-mm-dd` format. This field is required if the `TriggerEvent`\
\ field value is `SpecificDate`.\n**Character limit**: 29 "
format: date
type: string
TriggerEvent:
description: |2
Specifies when to start billing the customer for the charge.
**Note: **This field can be passed through the Subscribe and Amend calls and will override the default value set on the Product Rate Plan Charge.
**Character limit**: 18 **Values**: inherited from `ProductRatePlanCharge.TriggerEvent` and can be one of the following values:
- `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.
- `ServiceActivation` is when the services or products for a subscription have been activated and the customers have access.
- `CustomerAcceptance` is when the customer accepts the services or products for a subscription.
- `SpecificDate` is valid only on the RatePlanCharge.
type: string
UOM:
description: " Specifies the units to measure usage.\n**Character limit**:\
\ 25 **Values**: inherited from `ProductRatePlanCharge.UOM` "
type: string
UpToPeriods:
description: |2
Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.
**Character limit**: 5 **Values**: inherited from `ProductRatePlanCharge.UpToPeriods` **Note**:
- You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`.
- You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment.
- Use this field to override the value in `ProductRatePlanCharge.UpToPeriod`.
- If you override the value in this field, enter a whole number between 0 and 65535, exclusive.
- If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.
format: int64
type: integer
UpToPeriodsType:
description: |2
The period type used to define when the charge ends. This field can be updated when **Status** is `Draft`. **Values**: one of the following:
- `Billing Periods` (default)
- `Days`
- `Weeks`
- `Months`
- `Years`
**Note**:
- You must use this field together with the `UpToPeriods` field to specify the time period.
- This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`.
type: string
UpdatedById:
description: 'The ID of the last user to update the object. **Character
limit**: 32 **Values**: automatically generated '
type: string
UpdatedDate:
description: " The date when the object was last updated.\n**Character limit**:\
\ 29 **Values**: automatically generated "
format: date-time
type: string
Version:
description: ' The version of the rate plan charge. Each time a charge is
amended, Zuora creates a new version of the rate plan charge. **Character
limit**: 5 **Values**: automatically generated '
format: int64
type: integer
WeeklyBillCycleDay:
description: |2
Specifies which day of the week as the bill cycle day (BCD) for the charge.
This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
**Values**: one of the following:
- `Sunday`
- `Monday`
- `Tuesday`
- `Wednesday`
- `Thursday`
- `Friday`
- `Saturday`
type: string
type: object
- $ref: '#/definitions/RatePlanChargeObjectCustomFields'
ProxyGetRatePlanChargeTier:
properties:
CreatedById:
description: 'The ID of the Zuora user who created the RatePlanChargeTier
object. **Character limit**: 32 **Values**: automatically generated '
type: string
CreatedDate:
description: " The date when the RatePlanChargeTier object was created.\n\
**Character limit**: 29 **Values**: automatically generated "
format: date-time
type: string
EndingUnit:
description: " The end number of a range of units for the tier.\n**Character\
\ limit**: 16 **Values**: any positive decimal value "
format: double
type: number
Id:
description: Object identifier.
type: string
Price:
description: " The price of the tier if the charge is a flat fee, or the price\
\ of each unit in the tier if the change model is tiered pricing.\n**Character\
\ limit**: 16 **Values**: any positive decimal value "
format: double
type: number
PriceFormat:
description: " Indicates if the price is a flat fee or is per unit.\n**Character\
\ limit**: 8 **Values**: `Flat Fee`, `Per Unit` "
type: string
RatePlanChargeId:
description: " The ID of the subscription or amendment rate plan charge associated\
\ with this tier. You can't create an unassociated tier.\n**Character limit**:\
\ 32 **Values**: inherited from `RatePlanCharge.Id`. "
type: string
StartingUnit:
description: " The start number of a range of units for the tier.\n**Character\
\ limit**: 16 **Values**: any positive decimal value "
format: double
type: number
Tier:
description: " A unique number that identifies the tier that the price applies\
\ to.\n**Character limit**: 20 **Values**: automatically generated "
format: int32
type: integer
UpdatedById:
description: 'The ID of the last user to update the object. **Character limit**:
32 **Values**: automatically generated '
type: string
UpdatedDate:
description: " The date when the object was last updated.\n**Character limit**:\
\ 29 **Values**: automatically generated "
format: date-time
type: string
type: object
ProxyGetRefund:
allOf:
- properties:
AccountId:
description: " The ID of the account associated with this refund. Specify\
\ a value for this field only if you're creating an electronic non-referenced\
\ refund. Don't specify a value for any other type of refund; Zuora associates\
\ the refund automatically with the account from the associated payment.\n\
**Character limit**: 32 **Values**: a valid account ID "
type: string
AccountingCode:
description: " The accounting code for the payment or invoice line item\
\ that the refund applies to. If there is no accounting code, then this\
\ value is null. Accounting codes group transactions that contain similar\
\ accounting attributes.\n**Character limit**: 50 **Values**: automatically\
\ generated "
type: string
Amount:
description: " The amount of the refund. The amount can't exceed the amount\
\ of the associated payment. If the original payment was applied to a\
\ single invoice,\_you can create a partial refund by specifying an amount\
\ in this field or through the UI. If the payment was applied\_to multiple\
\ invoices, you can create a partial refund by using the `RefundInvoicePaymentData`\_\
field of this operation or through the UI.\n**Character limit**: 16 **Values**:\
\ a valid currency amount "
format: double
type: number
CancelledOn:
description: " The date the refund was cancelled.\n**Values**: automatically\
\ generated "
format: date-time
type: string
Comment:
description: " Use this field to record comments about the refund.\n**Character\
\ limit**: 255 **Values**: a string of 255 characters or fewer "
type: string
CreatedById:
description: " The ID of the Zuora user who created the `Refund` object.\n\
**Character limit**: 32 **Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the `Refund` object was created.\n**Character\
\ limit**: 29 **Values**: automatically generated "
format: date-time
type: string
Gateway:
description: " The gateway that processed the original payment. Zuora uses\
\ this same gateway for the corresponding refund. If this payment gateway\
\ is no longer active, then the electronic refund fails. A gateway is\
\ an online service provider that connects an online shopping cart to\
\ a payment processor.\n**Values**: automatically inherited from the `Payment`\
\ object "
type: string
GatewayResponse:
description: " The message returned from the payment gateway for the refund.\
\ This message is gateway-dependent.\n**Character limit**: 500 **Values**:\
\ automatically generated "
type: string
GatewayResponseCode:
description: " The code returned from the payment gateway for the payment.\
\ This code is gateway-dependent.\n**Character limit**: 20 **System****Values**:\
\ automatically generated "
type: string
GatewayState:
description: " The status of the payment in the gateway.\n**Character limit**:\
\ 19 **Values**: automatically generated "
type: string
Id:
description: Object identifier.
type: string
MarkedForSubmissionOn:
description: ' The date when a payment was marked and waiting for batch
submission to the payment process. **Character limit**: 29 **Values**:
automatically generated '
format: date-time
type: string
MethodType:
description: |2
Indicates how an external refund was issued to a customer. This field is required for an external refund. You can issue an external refund on an electronic payment. **Character limit**: 30 **Values**:
- `ACH`
- `Cash`
- `Check`
- `CreditCard`
- `Other`
- `PayPal`
- `WireTransfer`
- `DebitCard`
- `CreditCardReferenceTransaction`
type: string
PaymentMethodId:
description: " The unique ID of the payment method that the customer used\
\ to make the payment. Specify a value for this field only if you're creating\
\ an electronic non-referenced refund.\n**Character limit**: 32 **V****alues**:\
\ a valid payment method ID "
type: string
PaymentMethodSnapshotId:
description: " The unique ID of the payment method snapshot which is a copy\
\ of the particular Payment Method used in a transaction.\n**Character\
\ limit**: 32 **V****alues**: a valid payment method snapshot ID "
type: string
ReasonCode:
description: " A code identifying the reason for the transaction. Must be\
\ an existing reason code or empty. If you do not specify a value, Zuora\
\ uses the default reason code.\n**Character limit**: 32 **V****alues**:\
\ a valid reason code "
type: string
ReferenceID:
description: " The transaction ID returned by the payment gateway for an\
\ electronic refund. Use this field to reconcile refunds between your\
\ gateway and Zuora Payments.\n**Character limit**: 60 **Values**: a string\
\ of 60 characters or fewer "
type: string
RefundDate:
description: " The date of the refund, in `yyyy-mm-dd` format. The date\
\ of the refund cannot be before the payment date. Specify this field\
\ only for external refunds. Zuora automatically generates this field\
\ for electronic refunds.\n**Character limit**: 29 "
format: date
type: string
RefundNumber:
description: " The unique identifier of the refund.\n**Character limit**:\
\ 50 **Values**: automatically generated "
type: string
RefundTransactionTime:
description: " The date and time when the refund was issued.\n**Character\
\ limit**: 29 **Values**: automatically generated "
format: date-time
type: string
SecondRefundReferenceId:
description: " The transaction ID returned by the payment gateway if there\
\ is an additional transaction for the payment. Use this field to reconcile\
\ payments between your gateway and Zuora Payments.\n**Character limit**:\
\ 60 **Values**: a string of 60 characters or fewer "
type: string
SettledOn:
description: " The date when the payment was settled in the payment processor.\
\ This field is used by the Spectrum gateway only and not applicable to\
\ other gateways.\n**Character limit**: 29 **Values**: automatically generated "
format: date-time
type: string
SoftDescriptor:
description: |2
A payment gateway-specific field that maps Zuora to other gateways . **Character limit**: 35 **Values**:
- 3-byte company identifier "*" 18-byte descriptor
- 7-byte company identifier "*" 14-byte descriptor
- 12-byte company identifier "*" 9-byte descriptor
type: string
SoftDescriptorPhone:
description: |2
A payment gateway-specific field that maps Zuora to other gateways . **Character limit**: 20 **Values**:
- Customer service phone number formatted as: `NNN-NNN-NNNN` or `NNN-AAAAAAA`
- URL (non-e-Commerce): Transactions sent with a URL do not qualify for the best interchange rate
- Email address
type: string
SourceType:
description: |2
Specifies whether the refund is a refund payment or a credit balance. This field is required when creating an non-referenced refund. If you creating an non-referenced refund, then set this value to `CreditBalance`.
**Character limit**: 13 **Values**:
- `Payment`
- `CreditBalance`
type: string
Status:
description: |2
The status of the refund.
**Character limit**: 10 **Values**: automatically generated:
- `Canceled`
- `Error`
- `Processed`
- `Processing`
type: string
SubmittedOn:
description: " The date when the payment was submitted.\n**Character limit**:\
\ 29 **Values**: automatically generated "
format: date-time
type: string
TransferredToAccounting:
description: |2
Specifies whether or not the object has been transferred to an external accounting system. Use this field for integrations with accounting systems such as NetSuite.
**Character limit**: 10 **Values**: automatically generated:
- `Processing`
- `Yes`
- `Error`
- `Ignore`
type: string
Type:
description: |2
Specifies if the refund is electronic or external.
**Character limit**: 10 **Values**:
- `Electronic`
- External
type: string
UpdatedById:
description: " The ID of the last user to update the object.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the object was last updated.\n**Character limit**:\
\ 29 **Values**: automatically generated "
format: date-time
type: string
type: object
- $ref: '#/definitions/RefundObjectNSFields'
- $ref: '#/definitions/RefundObjectCustomFields'
ProxyGetRefundInvoicePayment:
properties:
CreatedById:
description: " The ID of the Zuora user who created the RefundInvoicePayment\
\ object.\n**Character limit**: 32 **Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the RefundInvoicePayment object was created.\n\
**Character limit**: 29 **Values**: automatically generated "
format: date-time
type: string
Id:
description: Object identifier.
type: string
InvoiceId:
description: " The unique ID of the invoice associated with this refund invoice\
\ payment.\n**Character limit**: 32 **Values**: a valid invoice ID "
type: string
InvoicePaymentId:
description: ' The ID of the `InvoicePayment.Id` '
type: string
RefundAmount:
description: 'Specifies the amount of a refund applied against a payment.
**Character limit**: 16 **Values**: automatically generated '
format: double
type: number
RefundId:
description: " The ID of the Refund object\n**Character limit**: 32 **Values**:\
\ inherited from `Refund.Id` "
type: string
UpdatedById:
description: " The ID of the last user to update the object.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the object was last updated.\n**Character limit**:\
\ 29 **Values**: automatically generated "
format: date-time
type: string
type: object
ProxyGetRefundTransactionLog:
properties:
BatchId:
description: ''
type: string
Gateway:
description: ''
type: string
GatewayReasonCode:
description: ''
type: string
GatewayReasonCodeDescription:
description: ''
type: string
GatewayState:
description: ''
type: string
GatewayTransactionType:
description: ''
type: string
Id:
description: Object identifier.
type: string
RefundId:
description: ''
type: string
RequestString:
description: ''
type: string
ResponseString:
description: ''
type: string
TransactionDate:
description: ''
format: date-time
type: string
TransactionId:
description: ''
type: string
type: object
ProxyGetSubscription:
allOf:
- properties:
AccountId:
description: ' This field can be updated when **Status** is `Draft`. The
ID of a valid account ID. '
type: string
AutoRenew:
description: " This field can be updated when **Status** is `Draft`. Indicates\
\ if the subscription automatically renews at the end of the term.\n**Values**:\
\ `true`, `false` "
type: boolean
CancelledDate:
description: ' The date on which the subscription was canceled. '
format: date
type: string
ContractAcceptanceDate:
description: ' The date when the customer accepts the contract. This field
can be updated when **Status** is `Draft`. '
format: date
type: string
ContractEffectiveDate:
description: " The date when the contract takes effect. This field can be\
\ updated when **Status** is `Draft`.\n**Note**: This field is required\
\ in the subscribe call. If you set the value of this field to null and\
\ both the ServiceActivationDate and ContractAcceptanceDate fields are\
\ not required, the subscribe call still returns success, but the new\
\ subscription is in `DRAFT` status. To activate the subscription, you\
\ must set a valid date to this field. "
format: date
type: string
CreatedById:
description: 'The user ID of the person who created the subscription. **Character
limit**: 32 **Values**: automatically generated '
type: string
CreatedDate:
description: " The date the subscription was created. This value is the\
\ same as the OriginalCreatedDate value until the subscription is amended.\n\
**Values**: automatically generated "
format: date-time
type: string
CreatorAccountId:
description: " The account ID that created the subscription or the amended\
\ subscription.\n**Character limit**: 32 **Values**: automatically generated "
type: string
CreatorInvoiceOwnerId:
description: " The account ID that owns the invoices associated with the\
\ subscription or the amended subscription.\n**Character limit**: 32 **Values**:\
\ automatically generated "
type: string
CurrentTerm:
description: " The length of the period for the current subscription term.\
\ If TermType is set to `TERMED`, this field is required and must be greater\
\ than `0`. If TermType is set to `EVERGREEN`, this value is ignored.\
\ Default is `0`.\n**Character limit**: 20 **Values**: automatically generated "
format: int32
type: integer
CurrentTermPeriodType:
description: |2
The period type for the current subscription term. This field is used with the CurrentTerm field to specify the current subscription term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
type: string
ExternallyManagedBy:
description: 'An enum field on the Subscription object to indicate the name
of a third-party store. This field is used to represent subscriptions
created through third-party stores.
'
enum:
- Amazon
- Apple
- Google
- Roku
type: string
Id:
description: Object identifier.
type: string
InitialTerm:
description: " The length of the period for the first subscription term.\
\ This field can be updated when Status is `Draft`.\n**Required**: If\
\ TermType is Termed **Character limit**: 20 **Values**: any valid number.\
\ The default value is 0. "
format: int32
type: integer
InitialTermPeriodType:
description: |2
The period type for the first subscription term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
**Note**:
- This field can be updated when Status is `Draft`.
- This field is used with the InitialTerm field to specify the initial subscription term.
type: string
InvoiceOwnerId:
description: ' This field can be updated when **Status** is `Draft`. A valid
account ID. '
type: string
IsInvoiceSeparate:
description: " Determines if the subscription is invoiced separately. If\
\ `TRUE`, then all charges for this subscription are collected into the\
\ subscription's own invoice.\n**Values**: `TRUE`, `FALSE `(default) "
type: boolean
IsLatestVersion:
description: " Determines if the subscription is the latest version. If\
\ the value of this field is `TRUE`, the subscription is the latest version.\n\
**Values**: `TRUE`, `FALSE `(default) "
type: boolean
Name:
description: |2
The unique identifier of the subscription. If you don't specify a value, then Zuora generates a name automatically. Whether auto-generated or manually specified, the subscription name must be unique. Otherwise an error will occur.
**Character limit**: 100 **Values**: one of the following:
- leave null to automatically generate
- a string of 100 characters or fewer
type: string
Notes:
description: " Use this field to record comments about the subscription.\n\
**Character limit**: 500 **Values**: a string of 500 characters or fewer "
type: string
OriginalCreatedDate:
description: " The date when the subscription was originally created. This\
\ value is the same as the CreatedDate value until the subscription is\
\ amended.\n**Values**: automatically generated "
format: date-time
type: string
OriginalId:
description: " The original ID of this subscription.\n**Values**: automatically\
\ generated "
type: string
PaymentTerm:
description: |
The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.
**Note:** This field is only available if you set the `X-Zuora-WSDL-Version` header parameter to `115` or later. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.
type: string
PreviousSubscriptionId:
description: " The subscription ID immediately prior to the current subscription.\n\
**Character limit**: 32 **Values**: automatically generated "
type: string
RenewalSetting:
description: " This field can be updated when **Status** is `Draft`. Specifies\
\ whether a termed subscription will remain termed or change to evergreen\
\ when it is renewed.\n**Required**: If TermType is Termed **Values**:\
\ `RENEW_WITH_SPECIFIC_TERM `(default), `RENEW_TO_EVERGREEN` "
type: string
RenewalTerm:
description: |2
The length of the period for the subscription renewal term. This field can be updated when **Status** is `Draft`.
**Required**: If TermType is Termed.
**Character limit**: 20 **Values**: one of the following:
- leave null to default to `0`
- any number
format: int32
type: integer
RenewalTermPeriodType:
description: |2
The period type for the subscription renewal term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
**Note**:
- This field is used with the RenewalTerm field to specify the subscription renewal term.
- This field can be updated when Status is `Draft`.
type: string
Revision:
description: |
An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the Revision value will be increased by 1. Also, the Revision value is always incremental regardless of deletion of subscription versions.
**Note:** To get this field, you must set the Zuora WSDL version to 107.0 or over in the `X-Zuora-WSDL-Version` header parameter.
type: string
ServiceActivationDate:
description: ' The date when the subscription is activated. This field can
be updated when **Status** is `Draft`. '
format: date
type: string
Status:
description: |2
The status of the subscription.
**Character limit**: 18 **Values**: automatically generated **Possible values**: one of the following:
- `Draft`
- `Pending Activation`
- `Pending Acceptance`
- `Active`
- `Cancelled`
- `Expired`
- `Suspended` (This value is in **Limited Availability**.)
type: string
SubscriptionBillToId:
description: |
The bill-to contact ID of the subscription.
**Note:** This field is only available if you set the `X-Zuora-WSDL-Version` header parameter to `121` or later. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.
type: string
SubscriptionBillToSnapshotId:
description: |
The snapshot ID of the subscription's bill-to contact. The snapshot ID will not change after the subscription version is created.
**Note:** This field is only available if you set the `X-Zuora-WSDL-Version` header parameter to `121` or later. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.
type: string
SubscriptionEndDate:
description: " The date when the subscription term ends, where the subscription\
\ ends at midnight the day before. For example, if the SubscriptionEndDate\
\ is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on\
\ 12/30/2016. This date is the same as the term end date or the cancelation\
\ date, as appropriate.\n**Character limit**: 29 **Values**: automatically\
\ generated "
format: date
type: string
SubscriptionStartDate:
description: " The date when the subscription term starts. This date is\
\ the same as the start date of the original term, which isn't necessarily\
\ the start date of the current or new term.\n**Character limit**: 29\
\ **Values**: automatically generated "
format: date
type: string
TermEndDate:
description: ' This field can be updated when **Status** is `Draft`. The
date when the subscription term ends. If the subscription is evergreen,
the TermEndDate value is null or is the cancelation date, as appropriate.
**Character limit**: 29 **Values**: automatically generated '
format: date
type: string
TermStartDate:
description: " This field can be updated when **Status** is `Draft`. The\
\ date when the subscription term begins. If this is a renewal subscription,\
\ then this date is different from the subscription start date.\n**Character\
\ limit**: 29 **Version notes**: -- "
format: date
type: string
TermType:
description: " This field can be updated when **Status** is `Draft`. Indicates\
\ if a subscription is termed or evergreen.\n**Character limit**: 9 **Values**:\
\ `TERMED`, `EVERGREEN` "
type: string
UpdatedById:
description: " The ID of the user who last updated the subscription.\n**Character\
\ limit:** 32 **Values: **automatically generated "
type: string
UpdatedDate:
description: " The date when the subscription was last updated.\n**Character\
\ limit:** 29 **Values**: automatically generated "
format: date-time
type: string
Version:
description: " The version number of the subscription.\n**Values**: automatically\
\ generated "
format: int32
type: integer
lastBookingDate:
description: "The last booking date of the subscription object. This field\
\ is writable only when the subscription is newly created as a first version\
\ subscription. You can override the date value when creating a subscription\
\ through the Subscribe and Amend API or the subscription creation UI\
\ (non-Orders). Otherwise, the default value `today` is set per the user's\
\ timezone. The value of this field is as follows:\n* For a new subscription\
\ created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate),\
\ this field has the value of the subscription creation date.\n* For a\
\ subscription changed by an amendment, this field has the value of the\
\ amendment booking date.\n* For a subscription created or changed by\
\ an order, this field has the value of the order date. "
format: date
type: string
Currency:
description: |
The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used.
All subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed.
**Note:** This field is available only if you have the Multiple Currencies feature enabled and set the `X-Zuora-WSDL-Version` header parameter to `137` or later.
type: string
type: object
- $ref: '#/definitions/SubscriptionObjectQTFields'
- $ref: '#/definitions/SubscriptionObjectNSFields'
- $ref: '#/definitions/SubscriptionObjectCustomFields'
ProxyGetSubscriptionProductFeature:
allOf:
- properties:
CreatedById:
description: ''
type: string
CreatedDate:
description: " Date and time when the product feature was added to the subscription.\n\
**Character limit**: 29 **Values**: "
format: date-time
type: string
Description:
description: " Description of the subscription product feature.\n**Character\
\ limit**: 500 **Values**: "
type: string
FeatureCode:
description: " Unique code of the feature.\n**Character limit**: 255 **Values**: "
type: string
FeatureId:
description: " Internal Zuora ID of the feature.\n**Character limit**: 32\
\ **Values**: "
type: string
Id:
description: Object identifier.
type: string
Name:
description: " Name of the feature.\n**Character limit**: 255 **Values**: "
type: string
RatePlanId:
description: " Id of the product rate plan to which the feature belongs.\n\
**Character limit**: 32 **Values**: "
type: string
UpdatedById:
description: " Internal Zuora ID of the user who last updated the subscription\
\ product feature.\n**Character limit**: 32 **Values**: "
type: string
UpdatedDate:
description: " Date and time when the subscription product feature was last\
\ updated.\n**Character limit**: 29 **Values**: "
format: date-time
type: string
type: object
- $ref: '#/definitions/SubscriptionProductFeatureObjectCustomFields'
ProxyGetTaxationItem:
allOf:
- properties:
AccountingCode:
description: ' The Chart of Accounts '
type: string
CreatedById:
description: " The ID of the user who created the taxation item.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the payment was created in the Zuora system.\n\
**Character limit**: 29 **Values**: automatically generated "
format: date-time
type: string
ExemptAmount:
description: " The calculated tax amount excluded due to the exemption.\n\
**Character limit**: 16 **Values**: a decimal value "
format: double
type: number
Id:
description: Object identifier.
type: string
InvoiceItemId:
description: " The ID of the specific invoice item that the taxation information\
\ applies to.\n**Character limit**: 32 **Values**: a valid invoice item\
\ ID "
type: string
Jurisdiction:
description: " The jurisdiction that applies the tax or VAT. This value\
\ is typically a state, province, county, or city.\n**Character limit**:\
\ 32 **Values**: a string of 32 characterrs or fewer "
type: string
LocationCode:
description: " The identifier for the location based on the value of the\
\ `TaxCode` field.\n**Character limit**: 32 **Values**: automatically\
\ generated "
type: string
Name:
description: " The name of the tax rate, such as sales tax or GST. This\
\ name is displayed on invoices.\n**Character limit**: 128 **Values**:\
\ a string of 128 characters or fewer "
type: string
TaxAmount:
description: " The amount of the tax applied to the charge.\n**Character\
\ limit**: 16 **Values**: a decimal value "
format: double
type: number
TaxCode:
description: " The tax code identifies which tax rules and tax rates to\
\ apply to a specific charge.\n**Character limit**: 32 **Values**: a string\
\ of 32 characters or fewer "
type: string
TaxCodeDescription:
description: " The description for the tax code.\n**Character limit**: 255\
\ **Values**: a string of 255 characters or fewer "
type: string
TaxDate:
description: " The date that the tax is applied to the charge, in `yyyy-mm-dd`\
\ format.\n**Character limit**: 29 "
format: date
type: string
TaxRate:
description: " The tax rate applied to the charge.\n**Character limit**:\
\ 16 **Values**: a valid decimal value "
format: double
type: number
TaxRateDescription:
description: " The description of the tax rate.\n**Character limit**: 255\
\ **Values**: a string of 255 characters or fewer "
type: string
TaxRateType:
description: " The type of the tax rate applied to the charge.\n**Character\
\ limit**: 10 **Values**: `Percentage`, `FlatFee` "
type: string
UpdatedById:
description: " The ID of the user who last updated the taxation item.\n\
**Character limit**: **Values**: automatically generated "
type: string
UpdatedDate:
description: 'The date when the taxation item was last updated. **Character
limit**: **Values**: automatically generated '
format: date-time
type: string
type: object
- $ref: '#/definitions/TaxationItemObjectCustomFields'
ProxyGetUnitOfMeasure:
properties:
Active:
description: " Indicates if the UOM is available for new product rate plans.\
\ The default value is `true`.\n**Character limit**: 5 **Values**: `true`,\
\ `false ` "
type: boolean
CreatedById:
description: " The ID of the Zuora user who created the UOM.\n**Character\
\ limit**: 32 **Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the UOM was created.\n**Character limit**: 29\
\ **Values**: automatically generated "
format: date-time
type: string
DecimalPlaces:
description: 'The number of digits to the right of the decimal point that
you want to measure for the unit. To use whole numbers only, set this value
to 0. You can''t change this value after this `UOM` is used in any product,
subscription, or usage. **Character limit**: 1 **Values**: an integer between
0 and 9, exclusive '
format: int64
type: integer
DisplayedAs:
description: 'The name of the UOM that you want displayed on invoices. The
default value is the `UomName` field value. **Character limit**: 50 **Values**:
A string of 50 characters or fewer '
type: string
Id:
description: Object identifier.
type: string
RoundingMode:
description: " Specifies whether to round the UOM value up or down when the\
\ value exceeds the `DecimalPlaces` field value. The default value is `Up`.\n\
**Character limit**: 4 **Values**: `Up`, `Down` "
type: string
UomName:
description: " The name of the UOM, such as license or GB. This name is displayed\
\ in query results and in the web-based UI labels. If you want a different\
\ name to be displayed on invoices, then use the `DisplayedAs` field to\
\ provide the invoice label.\n**Character limit**: 50 **Values**: a string\
\ of 50 characters or fewer "
type: string
UpdatedById:
description: 'The ID of the user who lasted updated the UOM. **Character limit**:
32 **Values**: automatically generated '
type: string
UpdatedDate:
description: " The date when the UOM was last updated.\n**Character limit**:\
\ 29 **Values**: automatically generated "
format: date-time
type: string
type: object
ProxyModifyAccount:
allOf:
- properties:
AccountNumber:
description: |
Unique account number assigned to the account. You can modify the account number of a customer account only if the account has no subscriptions or draft subscriptions only. Otherwise, the account number cannot be modified. **Character limit**: 50 **Values**: one of the following:
- null to auto-generate
- a string of 50 characters or fewer that doesn't begin with the default account number prefix
type: string
AdditionalEmailAddresses:
description: 'List of additional email addresses to receive email notifications.
**Character limit**: 120 **Values**: comma-separated list of email addresses '
type: string
AllowInvoiceEdit:
description: " Indicates if associated invoices can be edited.\n**Character\
\ limit**: 5 **Values**: `true`, `false` (default if left null) "
type: boolean
AutoPay:
description: " Indicates if future payments are automatically collected\
\ when they're due during a Payment Run.\n**Character limit**: 5 **Values**:\
\ `true`, `false` (default) "
type: boolean
Batch:
description: |
Organizes your customer accounts into groups to optimize\
\ your billing and payment operations. Required if you use the Subscribe\
\ call.\n**Character limit**: 20 **Values**:any system-defined batch (`Batch1`\
\ - `Batch50 `or by name). "
**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
type: string
BcdSettingOption:
description: 'Billing cycle day setting option. **Character limit**: 9 **Values**:
`AutoSet`, `ManualSet` '
type: string
BillCycleDay:
description: 'Billing cycle day (BCD) on which bill runs generate invoices
for the account. **Character limit**: 2 **Values**: any activated system-defined
bill cycle day (`1` - `31`) '
format: int32
type: integer
BillToId:
description: 'ID of the person to bill for the account. **Character limit**:
32 **Values**: a valid contact ID for the account '
type: string
CrmId:
description: 'CRM account ID for the account. A CRM is a customer relationship
management system, such as Salesforce.com. **Character limit**: 100 **Values**:
a string of 100 characters or fewer '
type: string
Currency:
description: "Currency that the customer is billed in. \n\nYou can update\
\ this field only when an account is in Draft status. After the account\
\ is activated, you cannot update this field.\n"
type: string
CustomerServiceRepName:
description: 'Name of the account''s customer service representative, if
applicable. **Character limit**: 50 **Values**: a string of 50 characters
or fewer '
type: string
DefaultPaymentMethodId:
description: 'ID of the default payment method for the account. This field
is required if the AutoPay field is set to `true`. **Character limit**: 32 **Values**:
a valid ID for an existing payment method '
type: string
InvoiceDeliveryPrefsEmail:
description: 'Indicates if the customer wants to receive invoices through
email. **Character limit**: 5 **Values**: `true`, `false` (default if
left null) '
type: boolean
InvoiceDeliveryPrefsPrint:
description: 'Indicates if the customer wants to receive printed invoices,
such as through postal mail. **Character limit**: 5 **Values**: `true`,
`false` (default if left null) '
type: boolean
InvoiceTemplateId:
description: 'The ID of the invoice template. Each customer account can
use a specific invoice template for invoice generation. **Character limit**:
32 **Values**: a valid template ID configured in Zuora Billing Settings '
type: string
Name:
description: 'Name of the account as displayed in the Zuora UI. **Character
limit**: 255 **Values**: a string of 255 characters or fewer '
type: string
Notes:
description: ' Comments about the account. **Character limit**: 65,535 **Values**:
a string of 65,535 characters '
type: string
ParentId:
description: 'Identifier of the parent customer account for this Account
object. Use this field if you have customer hierarchy enabled. **Character
limit**: 32 **Values**: a valid account ID '
type: string
PartnerAccount:
type: boolean
default: false
description: |
Whether the customer account is a partner, distributor, or reseller.
You can set this field to `true` if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests.
After this field is set to `true`, the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments.
**Note**:
- This field is available only if you have the Reseller Account feature enabled.
- This field is only available if you set the `X-Zuora-WSDL-Version` request header to `131` or later.
PaymentGateway:
description: |
Gateway used for processing electronic payments and refunds. **Character limit**: 40 **Values**: one of the following:
- a valid configured gateway name
- null to inherit the default value set in Zuora Payment Settings
type: string
PaymentTerm:
description: 'Indicates when the customer pays for subscriptions. **Character
limit**: 100 **Values**: a valid, active payment term defined in the web-based
UI administrative settings '
type: string
PurchaseOrderNumber:
description: 'The number of the purchase order associated with this account.
Purchase order information generally comes from customers. **Character
limit**: 100 **Values**: a string of 100 characters or fewer '
type: string
SalesRepName:
description: 'The name of the sales representative associated with this
account, if applicable. **Character limit**: 50 **Values**: a string of
50 characters or fewer '
type: string
SoldToId:
description: 'ID of the person who bought the subscription associated with
the account. **Character limit**: 32 **Values**: a valid contact ID for
the account '
type: string
Status:
description: "Status of the account in the system.\n\nFollow the following\
\ rules to update the status of accounts:\n- Include contact IDs in the\
\ `BillToId` and `SoldToId` fields when you change the `Status` field\
\ value to `Active`.\n- Before changing the status of an account to `Canceled`,\
\ cancel all subscriptions associated with this account. You cannot cancel\
\ an account that has active subscriptions.\n- You can update a Draft\
\ account to Active, assuming the Bill To/Sold To Contacts are assigned.\
\ \n- You can update a Canceled account to the Active status at any time.\n\
- You cannot update the Active or Cancelled status of an account to `Draft`.\n"
enum:
- Draft
- Active
- Canceled
maxLength: 8
type: string
TaxCompanyCode:
description: " Unique code that identifies a company account in Avalara.\
\ Use this field to calculate taxes based on origin and sold-to addresses\
\ in Avalara.\nThis 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**Character limit**: 50 **Values**: a valid company code "
type: string
TaxExemptCertificateID:
description: 'ID of your customer''s tax exemption certificate. **Character
limit**: 32 **Values**: a string of 32 characters or fewer '
type: string
TaxExemptCertificateType:
description: 'Type of the tax exemption certificate that your customer holds. **Character
limit**: 32 **Values**: a string of 32 characters or fewer '
type: string
TaxExemptDescription:
description: 'Description of the tax exemption certificate that your customer
holds. **Character limit**: 500 **Values**: a string of 500 characters
or fewer '
type: string
TaxExemptEffectiveDate:
description: 'Date when the the customer''s tax exemption starts. **Character
limit**: 29 **Version notes**: requires Zuora Tax '
format: date
type: string
TaxExemptExpirationDate:
description: 'Date when the customer''s tax exemption certificate expires **Character
limit**: 29 **Version notes**: requires Zuora Tax '
format: date
type: string
TaxExemptIssuingJurisdiction:
description: 'Indicates the jurisdiction in which the customer''s tax exemption
certificate was issued. **Character limit**: 32 **Values**: a string of
32 characters or fewer '
type: string
TaxExemptStatus:
description: |2
Status of the account's tax exemption. Required if you use Zuora Tax.
**Character limit**: 19 **Values**: one of the following:
- `Yes`
- `No`
- `PendingVerification`
type: string
VATId:
description: " EU Value Added Tax ID.\nThis 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**Character limit**:\
\ 25 **Values**: a valid Value Added Tax ID "
type: string
communicationProfileId:
description: 'Associates the account with a specified communication profile.
**Character limit**: 32 **Values**: a valid communication profile ID '
type: string
type: object
- $ref: '#/definitions/AccountObjectNSFields'
- $ref: '#/definitions/AccountObjectCustomFields'
example:
BillCycleDay: 1
ProxyModifyAmendment:
allOf:
- 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. This field can be updated when Status is `Draft`. **Required:**\
\ For amendment of type TermsAndConditions when changing the automatic\
\ renewal status of a subscription.\n**Values**: true, false "
type: boolean
ContractEffectiveDate:
description: " The date when the amendment's changes become effective for\
\ billing purposes.\n**Version notes**: -- "
format: date
type: string
CurrentTerm:
description: " The length of the period for the current subscription term.\
\ This field can be updated when Status is `Draft`.\n**Required**: Only\
\ if the value of the Type field is set to `TermsAndConditions` and TermType\
\ is set to `TERMED`. This field is not required if TermType is set to\
\ `EVERGREEN`.\n**Character limit**: **Values**: a valid number "
format: int64
type: integer
CurrentTermPeriodType:
description: |2
The period type for the current subscription term. This field can be updated when Status is `Draft`. **Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
**Note**:
- This field can be updated when Status is `Draft`.
- This field is used with the CurrentTerm field to specify the current subscription term.
type: string
CustomerAcceptanceDate:
description: |
The date when the customer accepts the amendment's changes to the subscription.
This field is only required if [Zuora is configured to require customer acceptance in Z-Billing](https://knowledgecenter.zuora.com/CB_Billing/W_Billing_and_Payments_Settings/Define_Default_Subscription_Settings) and the subscription is currently in the Pending Acceptance status (the value of the `Status` field is currently `PendingAcceptance`).
Use this field together with the `Status` field. When you set a date in this field as a customer acceptance date, you should also set the `Status` field as `Completed`.
format: date
type: string
Description:
description: " A description of the amendment. This field can be updated\
\ when Status is `Draft`.\n**Character limit**: 500 **Values**: maximum\
\ 500 characters "
type: string
EffectiveDate:
description: " The date when the amendment's changes take effective. This\
\ field validates that the amendment's changes are within valid ranges\
\ of products and product rate plans.\n**Required**: For the cancellation\
\ amendments. Optional for other types of amendments.\n**Version notes**:\
\ -- "
format: date
type: string
Name:
description: " The name of the amendment. This field can be updated when\
\ Status is `Draft`.\n**Character limit**: 100 **Values**: a string of\
\ 100 characters or fewer "
type: string
RenewalSetting:
description: " Specifies whether a termed subscription will remain termed\
\ or change to evergreen when it is renewed.\n**Required**: If TermType\
\ is Termed **Values**: RENEW_WITH_SPECIFIC_TERM (default), RENEW_TO_EVERGREEN "
type: string
RenewalTerm:
description: " The term of renewal for the amended subscription. This field\
\ can be updated when Status is `Draft`.\n**Required**: Only if the value\
\ of the Type field is set to `TermsAndConditions`.\n**Character limit**:\
\ **Values:** a valid number "
format: int64
type: integer
RenewalTermPeriodType:
description: |2
The period type for the subscription renewal term. This field can be updated when Status is `Draft`.
**Required**: Only if the value of the Type field is set to `TermsAndConditions`. This field is used with the RenewalTerm field to specify the subscription renewal term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
type: string
ServiceActivationDate:
description: |
The date when service is activated.
This field is only required if [Zuora is configured to require service activation in Z-Billing](https://knowledgecenter.zuora.com/CB_Billing/W_Billing_and_Payments_Settings/Define_Default_Subscription_Settings) and the subscription is currently in the Pending Activation status (the value of the `Status` field is currently `PendingActivation`).
Use this field together with the `Status` field. When you set a date in this field as a service activation date, you should also set the `Status` field as the expected next phase status: `Completed` or `PendingAcceptance`.
format: date
type: string
SpecificUpdateDate:
description: |2
The date when the UpdateProduct amendment takes effect. This field is only applicable if there is already a future-dated UpdateProduct amendment on the subscription.
**Required**: Only for the UpdateProduct amendments if there is already a future-dated UpdateProduct amendment on the subscription.
format: date
type: string
Status:
description: |2
The status of the amendment. Type: string (enum) **Character limit**: 17 **Values**: one of the following:
- Draft (default, if left null)
- Pending Activation
- Pending Acceptance
- Completed
type: string
SubscriptionId:
description: " The ID of the subscription that the amendment changes. This\
\ field can be updated when Status is `Draft`.\n**Character limit**: 32\
\ **Values**: a valid subscription ID "
type: string
TermStartDate:
description: " The date when the new terms and conditions take effect.\n\
**Required**: Only if the value of the Type field is set to TermsAndConditions.\n\
**Version notes**: -- "
format: date
type: string
TermType:
description: " Indicates if the subscription is TERMED or EVERGREEN. This\
\ field can be updated when Status is `Draft`.\n\n- A TERMED subscription\
\ has an expiration date, and must be manually renewed.\n- An EVERGREEN\
\ subscription doesn't have an expiration date, and must be manually ended.\n\
\n**Required**: Only when as part of an amendment of type TermsAndConditions\
\ to change the term type of a subscription. Type: string **Character\
\ limit**: 9 **Values**: TERMED, EVERGREEN "
type: string
Type:
description: |2
The type of amendment. This field can be updated when Status is `Draft`.
**Character limit**: 18 **Values**: one of the following:
- Cancellation
- NewProduct
- OwnerTransfer
- RemoveProduct
- Renewal
- UpdateProduct
- TermsAndConditions
- SuspendSubscription
- ResumeSubscription
type: string
type: object
- $ref: '#/definitions/AmendmentObjectCustomFields'
example:
Id: 2c93808457d787030157e02e430c1f15
Name: AMtssl1bnuq1_new
ProxyModifyCreditBalanceAdjustment:
allOf:
- properties:
ReasonCode:
description: 'A code identifying the reason for the transaction. Must be
an existing [reason code](https://knowledgecenter.zuora.com/CB_Billing/K_Payment_Operations/Reason_Codes_for_Payment_Operations)
or empty.
'
maxLength: 32
type: string
Status:
description: 'The status of the credit balance adjustment.
'
enum:
- Processed
- Canceled
type: string
TransferredToAccounting:
description: 'Status of the credit balance adjustment''s transfer to an
external accounting system, such as NetSuite.
'
enum:
- Processing
- 'Yes'
- Error
- Ignore
type: string
type: object
- $ref: '#/definitions/CreditBalanceAdjustmentObjectNSFields'
- $ref: '#/definitions/CreditBalanceAdjustmentObjectCustomFields'
example:
Status: Canceled
ProxyModifyFeature:
allOf:
- properties:
Description:
description: 'Description of the feature.
'
maxLength: 1000
type: string
FeatureCode:
description: 'Unique code of the feature.
'
maxLength: 255
type: string
Name:
description: 'Name of the feature.
'
maxLength: 255
type: string
Status:
description: 'Status of the feature.
'
enum:
- Active
- Inactive
type: string
type: object
- $ref: '#/definitions/FeatureObjectCustomFields'
example:
Description: This feature has been discontinued
Status: Inactive
ProxyModifyInvoice:
allOf:
- properties:
RegenerateInvoicePDF:
description: "Whether to regenerate a PDF file for an invoice that already\
\ has PDF files generated. \n\nThis field is valid only if you enable\
\ the billing document file generation feature. To enable this feature,\
\ you have to select the **Enable the billing document generation** check\
\ box after navigating to **Billing** > **Manage Billing Document Configuration**\
\ through the Zuora UI. Otherwise, the request is rejected. \n\nFor one\
\ specific invoice, you can use this field to regenerate PDF files for\
\ a maximum of 100 times.\n\n**Note**: If you set this field to `true`,\
\ you cannot update any other fields in the same update request. Otherwise,\
\ you will receive the following INVALID_VALUE error:\n\n\"When field\
\ RegenerateInvoicePDF is set to true to regenerate the invoice PDF file,\
\ changes on other fields of the invoice are not allowed.\"\n"
type: boolean
Status:
description: |
The status of the invoice in the system. This status is not the status of the payment of the invoice, just the status of the invoice itself.
With the [Cancel Posted Billing Documents](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions) billing permission, you can directly update the status of an invoice from Posted to Draft.
**Character limit**: 8
**Values**: one of the following:
- Draft (default, automatically set upon invoice creation)
- Posted
- Canceled
type: string
TransferredToAccounting:
description: " Specifies whether or not the invoice was transferred to an\
\ external accounting system, such as NetSuite.\n**Character limit**:\
\ 10 **Values**: Processing, Yes, Error, Ignore "
type: string
type: object
- $ref: '#/definitions/InvoiceObjectNSFields'
- $ref: '#/definitions/InvoiceObjectCustomFields'
example:
Status: Posted
ProxyModifyInvoiceAdjustment:
allOf:
- properties:
ReasonCode:
description: " A code identifying the reason for the transaction. Must be\
\ an existing reason code or empty. If you do not specify a value, Zuora\
\ uses the default reason code.\n**Character limit**: 32 **V****alues**:\
\ a valid reason code "
type: string
Status:
description: " The status of the invoice adjustment. This field is required\
\ in the Query call, but is automatically generated in other calls.\n\
**Character limit**: 9 **Values**: `Canceled`, `Processed` "
type: string
TransferredToAccounting:
description: 'Indicates the status of the adjustment''s transfer to an external
accounting system, such as NetSuite.
'
enum:
- Processing
- 'Yes'
- 'No'
- Error
- Ignore
type: string
type: object
- $ref: '#/definitions/InvoiceAdjustmentObjectCustomFields'
ProxyModifyInvoiceItemAdjustment:
allOf:
- properties:
ExcludeItemBillingFromRevenueAccounting:
default: false
description: "The flag to exclude Order Line Item related invoice items,\
\ invoice item adjustments, credit memo items, and debit memo items that\
\ are generate for the rate plan charge from revenue accounting. Set this\
\ field to `true` to exclude the billing item from the revenue accounting.\n\
\n\n**Character limit**: 100 \n\n\n**Version notes**: WSDL 117.0+\n\n\
\n**Values**: a boolean value\n\n**Note**: This field is only available\
\ if you have the Billing - Revenue Integration feature enabled.\n"
type: boolean
ReasonCode:
description: " A code identifying the reason for the transaction. Must be\
\ an existing reason code or empty. If you do not specify a value, Zuora\
\ uses the default reason code.\n**Character limit**: 32 **Values**: a\
\ valid reason code "
type: string
Status:
description: " The status of the invoice item adjustment. This field is\
\ required in the Query call, but is automatically generated in other\
\ calls.\n**Character limit**: 9 **Values**: Canceled, Processed "
type: string
TransferredToAccounting:
description: 'Indicates the status of the adjustment''s transfer to an external
accounting system, such as NetSuite.
'
enum:
- Processing
- 'Yes'
- 'No'
- Error
- Ignore
type: string
type: object
- $ref: '#/definitions/InvoiceItemAdjustmentObjectNSFields'
- $ref: '#/definitions/InvoiceItemAdjustmentObjectCustomFields'
example:
Status: Canceled
ProxyModifyInvoicePayment:
properties:
Amount:
description: " The amount of the payment.\n**Character limit**: 16 **Values**:\
\ a valid currency amount "
format: double
type: number
type: object
ProxyModifyPayment:
allOf:
- properties:
AccountingCode:
description: 'The accounting code for the payment. Accounting codes group
transactions that contain similar accounting attributes.
'
maxLength: 100
minLength: 0
type: string
Status:
description: |
The updated status of the payment. The value depends on the type of payment.
- For Electronic payment, the available value is `Voided`.
- For External payment, the available value is `Canceled`.
enum:
- Voided
- Canceled
type: string
TransferredToAccounting:
description: 'Whether the refund was transferred to an external accounting
system. Use this field for integration with accounting systems, such as
NetSuite.
'
enum:
- Processing
- 'Yes'
- Error
- Ignore
type: string
type: object
- $ref: '#/definitions/PaymentObjectNSFields'
- $ref: '#/definitions/PaymentObjectCustomFields'
example:
AccountingCode: Accounts Receivable
ProxyModifyPaymentMethod:
allOf:
- properties:
AccountId:
description: " The ID of the customer account associated with this payment\
\ method.\n\n**Note:** If a payment method was created without an account\
\ ID associated, you can update the payment method to specify an account\
\ ID in this operation. However, if a payment method is already associated\
\ with a customer account, you cannot update the payment method to associate\
\ it with another account ID. You cannot remove the previous account ID\
\ and leave the `AccountId` filed empty in this operation. "
type: string
AchAbaCode:
description: " The nine-digit routing number or ABA number used by banks.\
\ Use this field for ACH payment methods.\n\n**Character limit**: 9 **Values**:\
\ a string of 9 characters or fewer "
type: string
AchAccountName:
description: " The name of the account holder, which can be either a person\
\ or a company. Use this field for ACH payment methods.\n\n**Character\
\ limit**: 70 **Values**: a string of 70 characters or fewer "
type: string
AchAccountType:
description: |2
The type of bank account associated with the ACH payment. Use this field for ACH payment methods.
When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably.
**Character limit**: 16 **Values**:
- `BusinessChecking`
- `BusinessSaving`
- `Checking`
- `Saving`
type: string
AchAddress1:
description: " Line 1 for the ACH address. Required on create for the Vantiv\
\ payment gateway. Optional for other gateways.\n\n**Character limit:**\
\ **Values:** an address "
type: string
AchAddress2:
description: " Line 2 for the ACH address. Required on create for the Vantiv\
\ payment gateway. Optional for other gateways.\n\n**Character limit:**\
\ **Values:** an address "
type: string
AchBankName:
description: " The name of the bank where the ACH payment account is held.\
\ Use this field for ACH payment methods.\nWhen creating an ACH payment\
\ method on Adyen, this field is required by Zuora but it is not required\
\ by Adyen. To create the ACH payment method successfully, specify a real\
\ value for this field if you can. If it is not possible to get the real\
\ value for it, specify a dummy value.\n\n**Character limit**: 70 **Values**:\
\ a string of 70 characters or fewer "
type: string
AchCity:
description: "The city of the ACH address. Use this field for ACH payment\
\ methods. **Note**: This field is only specific to the NMI payment gateway.\n\
**Character limit**: 40 **Values**: a string of 40 characters or fewer "
type: string
AchCountry:
description: "The country of the ACH address. See [Country Names and Their\
\ ISO Standard 2- and 3-Digit Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/A_Country_Names_and_Their_ISO_Codes)\
\ for the list of supported country names. Use this field for ACH methods.\n\
**Note**: This field is only specific to the NMI payment gateway.\n\n\
**Character limit**: 44 **Values**: a supported country name "
type: string
AchPostalCode:
description: "The billing address's zip code. This field is required only\
\ when you define an ACH payment method. **Note**: This field is only\
\ specific to the NMI payment gateway.\n\n**Character limit**: 20 **Values**:\
\ a string of 40 characters or fewer "
type: string
AchState:
description: "The billing address's state. Use this field is if the `ACHCountry`\
\ value is either `Canada` or the `US`. State names must be spelled in\
\ full. For more information, see the list of [supported state names](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/B_State_Names_and_2-Digit_Codes).\
\ This field is required only when you define an ACH payment method. **Note**:\
\ This field is only specific to the NMI payment gateway.\n\n**Character\
\ limit**: 50 **Values**: a valid state name "
type: string
BankBranchCode:
description: |
The branch code of the bank used for direct debit. Use this field for the following bank transfer payment methods:
- Sweden Direct Debit (`Autogiro`)
- Direct Debit NZ (`DirectDebitNZ`)
- Pre-Authorized Debit (`PAD`)
**Character limit**: 10
type: string
BankCheckDigit:
description: "The check digit in the international bank account number,\
\ which confirms the validity of the account. Use this field for direct\
\ debit payment methods.\n\n**Character limit**: 4 **Values**: string\
\ of 4 characters or fewer "
type: string
BankCode:
description: |
The sort code or number that identifies the bank. This is also known as the sort code. Use this field for the following bank transfer payment methods:
- Direct Debit UK (`Bacs`)
- Denmark Direct Debit (`Betalingsservice`)
- Direct Debit NZ (`DirectDebitNZ`)
- Pre-Authorized Debit (`PAD`)
type: string
BankTransferType:
description: "The type of direct debit transfer. The value of this field\
\ is dependent on the country of the user. This field is only required\
\ if the `Type` field is set to `BankTransfer`.\n\n**Values**: \n\n -\
\ `SEPA`\n\n - `DirectEntryAU` (Australia)\n\n - `DirectDebitUK` (UK)\n\
\n - `Autogiro` (Sweden)\n\n - `Betalingsservice` (Denmark)\n\n - `DirectDebitNZ`\
\ (New Zealand)\n \n - `PAD` (Canada)\n \n - `AutomatischIncasso`\
\ (Netherlands)\n\n - `LastschriftDE` (Germany)\n\n - `LastschriftAT`\
\ (Austria)\n\n - `DemandeDePrelevement` (France)\n\n - `Domicil` (Belgium)\n\
\n - `LastschriftCH` (Switzerland)\n\n - `RID` (Italy)\n\n - `OrdenDeDomiciliacion`\
\ (Spain)\n"
maxLength: 20
type: string
BusinessIdentificationCode:
description: " The business identification code for Swiss direct payment\
\ methods that use the Global Collect payment gateway. Use this field\
\ only for direct debit payments in Switzerland with Global Collect.\n\
\n**Character limit**: 11 **Values**: string of 11 characters or fewer "
type: string
City:
description: " The city of the customer's address. Use this field for direct\
\ debit payment methods.\n\n**Character limit**:80 **Values**: string\
\ of 80 characters or fewer "
type: string
CompanyName:
description: |
The name of the company.
Zuora does not recommend that you use this field.
maxLength: 80
type: string
Country:
description: |
The two-letter country code of the customer's address. Use this field for the following bank transfer payment methods:
- `Autogiro`
- `Betalingsservice`
- `DirectDebitUK`
- `DirectEntryAU`
- `DirectDebitNZ`
- `PAD`
type: string
CreditCardAddress1:
description: " The first line of the card holder's address, which is often\
\ a street address or business name. Use this field for credit card and\
\ direct debit payment methods.\n\n**Character limit**: 255 **Values**:\
\ a string of 255 characters or fewer "
type: string
CreditCardAddress2:
description: " The second line of the card holder's address. Use this field\
\ for credit card and direct debit payment methods.\n\n**Character limit**:\
\ 255 **Values**: a string of 255 characters or fewer "
type: string
CreditCardCity:
description: " The city of the card holder's address. Use this field for\
\ credit card and direct debit payment methods\n\n**Character limit**:\
\ 40 **Values**: a string of 40 characters or fewer "
type: string
CreditCardCountry:
description: ' The country of the card holder''s address. '
type: string
CreditCardExpirationMonth:
description: " The expiration month of the credit card or debit card. Use\
\ this field for credit card and direct debit payment methods.\n\n**Character\
\ limit**: 2 **Values**: a two-digit number, 01 - 12 "
format: int32
type: integer
CreditCardExpirationYear:
description: " The expiration month of the credit card or debit card. Use\
\ this field for credit card and direct debit payment methods.\n\n**Character\
\ limit**: 4 **Values**: a four-digit number "
format: int32
type: integer
CreditCardHolderName:
description: " The full name of the card holder. Use this field for credit\
\ card and direct debit payment methods.\n\n**Character limit**: 50 **Values**:\
\ a string of 50 characters or fewer "
type: string
CreditCardPostalCode:
description: " The billing address's zip code. This field is required only\
\ when you define a debit card or credit card payment.\n**Character limit**:\
\ 20 **Values**: a string of 20 characters or fewer "
type: string
CreditCardSecurityCode:
description: " The CVV or CVV2 security code. See [How do I control what\
\ information Zuora sends over to the Payment Gateway?](https://knowledgecenter.zuora.com/kb/How_do_I_control_information_sent_to_payment_gateways_when_verifying_payment_methods%3F)\
\ for more information. To ensure PCI compliance, this value is not stored\
\ and cannot be queried.\n**Values**: a valid CVV or CVV2 security code "
type: string
CreditCardState:
description: ' The billing address''s state. Use this field is if the `CreditCardCountry''
value is either Canada or the US. State names must be spelled in full. '
type: string
CreditCardType:
description: |
The type of the credit card.
Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).
type: string
DeviceSessionId:
description: " The session ID of the user when the `PaymentMethod` was created\
\ or updated. Some gateways use this field for fraud prevention. If this\
\ field is passed to Zuora, then Zuora passes this field to supported\
\ gateways. Currently only Verifi supports this field.\n**Character limit**:\
\ 255 **Values**: "
type: string
Email:
description: " An email address for the payment method in addition to the\
\ bill to contact email address.\n**Character limit**: 80 **Values**:\
\ a string of 80 characters or fewer "
type: string
ExistingMandate:
description: " Indicates if the customer has an existing mandate or a new\
\ mandate. A mandate is a signed authorization for UK and NL customers.\
\ When you are migrating mandates from another system, be sure to set\
\ this field correctly. If you indicate that a new mandate is an existing\
\ mandate or vice-versa, then transactions fail. This field is used only\
\ for the direct debit payment method.\n**Character limit**: 3 **Values**:\
\ `Yes`, `No` "
type: string
FirstName:
description: " The customer's first name. This field is used only for the\
\ direct debit payment method.\n**Character limit**: 30 **Values**: a\
\ string of 30 characters or fewer "
type: string
IBAN:
description: " The International Bank Account Number. This field is used\
\ only for the direct debit payment method.\n**Character limit**: 42 **Values**:\
\ a string of 42 characters or fewer "
type: string
IPAddress:
description: ' The IPv4 or IPv6 information of the user when the payment
method was created or updated. Gateways use this field for fraud prevention.
If this field is passed to Zuora, then Zuora passes this field to supported
gateways. If the IP address length is beyond 45 characters, a validation
error occurs. '
type: string
IdentityNumber:
description: "The unique identity number of the customer account. \n\nThis\
\ field is required only if the `BankTransferType` field is set to `Autogiro`\
\ or `Betalingsservice`. It is a string of 12 characters for a Swedish\
\ identity number, and a string of 10 characters for a Denish identity\
\ number.\n"
type: string
IsCompany:
default: false
description: |
Whether the customer account is a company.
Zuora does not recommend that you use this field.
type: boolean
LastName:
description: " The customer's last name. This field is used only for the\
\ direct debit payment method.\n**Character limit**: 70 **Values**: a\
\ string of 70 characters or fewer "
type: string
LastTransactionDateTime:
description: " The date of the most recent transaction.\n**Character limit**:\
\ 29 **Values**: a valid date and time value "
format: date-time
type: string
MandateCreationDate:
description: " The date when the mandate was created, in `yyyy-mm-dd` format.\
\ A mandate is a signed authorization for UK and NL customers. This field\
\ is used only for the direct debit payment method.\n**Character limit**:\
\ 29 "
format: date
type: string
MandateID:
description: " The ID of the mandate. A mandate is a signed authorization\
\ for UK and NL customers. This field is used only for the direct debit\
\ payment method.\n**Character limit**: 36 **Values**: a string of 36\
\ characters or fewer "
type: string
MandateReceived:
description: " Indicates if the mandate was received. A mandate is a signed\
\ authorization for UK and NL customers. This field is used only for the\
\ direct debit payment method.\n**Character limit**: 3 **Values**: `Yes`,\
\ `No `(case-sensitive) "
type: string
MandateUpdateDate:
description: " The date when the mandate was last updated, in `yyyy-mm-dd`\
\ format. A mandate is a signed authorization for UK and NL customers.\
\ This field is used only for the direct debit payment method.\n**Character\
\ limit**: 29 "
format: date
type: string
MaxConsecutivePaymentFailures:
description: " Specifies the number of allowable consecutive failures Zuora\
\ attempts with the payment method before stopping.\n**Values**: a valid\
\ number "
type: integer
NumConsecutiveFailures:
description: "The number of consecutive failed payments for this payment\
\ method. It is reset to `0` upon successful payment. \n"
maximum: 100
minimum: 0
type: integer
PaymentMethodStatus:
description: " This field is used to indicate the status of the payment\
\ method created within an account. It is set to `Active` on creation.\n\
**Character limit**: 6 **Values**: `Active` or `Closed` "
type: string
PaymentRetryWindow:
description: " The retry interval setting, which prevents making a payment\
\ attempt if the last failed attempt was within the last specified number\
\ of hours. This field is required if the `UseDefaultRetryRule` field\
\ value is set to `false`.\n**Character limit**: 4 **Values**: a whole\
\ number between 1 and 1000, exclusive "
type: integer
Phone:
description: " The phone number that the account holder registered with\
\ the bank. This field is used for credit card validation when passing\
\ to a gateway.\n**Character limit**: 40 **Values**: a string of 40 characters\
\ or fewer "
type: string
PostalCode:
description: " The zip code of the customer's address. This field is used\
\ only for the direct debit payment method.\n**Character limit**: 20 **Values**:\
\ a string of 20 characters or fewer "
type: string
SecondTokenId:
description: "A gateway unique identifier that replaces sensitive payment\
\ method data. `SecondTokenId` is conditionally required only when `TokenId`\
\ is being used to represent a gateway customer profile. `TokenID` is\
\ being used to represent a gateway customer profile. `SecondTokenId`\
\ is used in the CC Reference Transaction payment method.\n**Character\
\ limit**: 64 **Values**: a string of 64 characters or fewer "
type: string
State:
description: " The state of the customer's address. This field is used only\
\ for the direct debit payment method.\n**Character limit**: 70 **Values**:\
\ a string of 70 characters or fewer "
type: string
StreetName:
description: " The street name of the customer's address. This field is\
\ used only for the direct debit payment method.\n**Character limit**:\
\ 100 **Values**: a string of 100 characters or fewer "
type: string
StreetNumber:
description: " The street number of the customer's address. This field is\
\ used only for the direct debit payment method.\n**Character limit**:\
\ 30 **Values**: a string of 30 characters or fewer "
type: string
UseDefaultRetryRule:
description: " Determines whether to use the default retry rules configured\
\ in the Zuora Payments settings. Set this to `true` to use the default\
\ retry rules. Set this to `false` to set the specific rules for this\
\ payment method. If you set this value to `false`, then the fields, `PaymentRetryWindow`\
\ and `MaxConsecutivePaymentFailures`, are required.\n**Character limit**:\
\ 5 **Values**: `true` or `false` "
type: boolean
type: object
- $ref: '#/definitions/PaymentMethodObjectCustomFields'
example:
CreditCardCountry: United States
CreditCardState: CA
ProxyModifyRatePlanCharge:
allOf:
- properties:
BillingTiming:
description: |2+
The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types.
**Character limit**: **Values**: one of the following:
- `In Advance`
- `In Arrears`
**Note:** You can override the value inherited from the Product Rate Plan Charge when a subscription has a recurring charge type.
type: string
DiscountAmount:
description: 'Specifies the amount of a fixed-amount discount. You can provide
a value for this field if the `ChargeModel` field value is `Discount-Fixed
Amount`. **Character limit**: 16 **Values**: A valid currency amount
'
format: decimal
type: number
DiscountPercentage:
description: 'The percentage of discount for a percentage discount. Use
this field if the value for `ProductRatePlanCharge.ChargeModel` is `Discount-Percentage`
and you want to override the value in `ProductRatePlanChargeTier.DiscountPercentage`.
**Character limit**: 16 **Values**: a decimal value between -100 and 100,
exclusive
'
format: decimal
type: number
EndDateCondition:
description: " Defines when the charge ends after the charge trigger date.\
\ This field can be updated when **Status** is `Draft`.\n**Values**: one\
\ of the following:\n\n- `SubscriptionEnd`: The charge ends on the subscription\
\ end date after the charge trigger date. This is the default value.\n\
- `FixedPeriod`: The charge ends after a specified period based on the\
\ trigger date of the charge. If you set this field to `FixedPeriod`,\
\ you must specify the length of the period and a period type by defining\
\ the `UpToPeriods` and `UpToPeriodsType` fields.\n- `SpecificEndDate`:\
\ The specific date on which the charge ends. If you set this field to\
\ `SpecificEndDate`, you must specify the specific date by defining the\
\ `SpecificEndDate` field.\n\n**Note**: If the subscription ends before\
\ the charge end date, the charge ends when the subscription ends. But\
\ if the subscription end date is subsequently changed through a Renewal,\
\ or Terms and Conditions amendment, the charge will end on the charge\
\ end date. "
type: string
ListPriceBase:
description: |
The list price base for the product rate plan charge.
enum:
- Per Month
- Per Billing Period
- Per Week
- Per Year
- Per Specific Months
type: string
PriceChangeOption:
description: |2
Applies an automatic price change when a termed subscription is renewed.
**Character limit**: **Values**: one of the following:
- `NoChange` (default)
- `SpecificPercentageValue`
- `UseLatestProductCatalogPricing`
type: string
PriceIncreasePercentage:
description: " Specifies the percentage to increase or decrease the price\
\ of renewed subscriptions.\n**Character limit**: 16 **Values**: a decimal\
\ value between -100 and 100 "
format: double
type: number
RatingGroup:
description: "Specifies a rating group based on which usage records are\
\ rated. \n\n* `ByBillingPeriod` (default) - The rating is based on all\
\ the usages in a billing period. \n* `ByUsageStartDate` - The rating\
\ is based on all the usages on the same usage start date.\n* `ByUsageRecord`\
\ - The rating is based on each usage record.\n* `ByUsageUpload` - The\
\ rating is based on all the usages in a uploaded usage file (`.xls` or\
\ `.csv`). If you import a mass usage in a single upload, which contains\
\ multiple usage files in `.xls` or `.csv` format, usage records are grouped\
\ for each usage file.\n* `ByGroupId` - The rating is based on all the\
\ usages in the same custom group. \n\n\n**Note:** \n- The `ByBillingPeriod`\
\ value can be applied for all charge models. \n- The `ByUsageStartDate`,\
\ `ByUsageRecord`, and `ByUsageUpload` values can only be applied for\
\ per unit, volume pricing, and tiered pricing charge models. \n- The\
\ `ByGroupId` value is only available if you have the Active Rating feature\
\ enabled.\n- Use this field only for Usage charges. One-Time Charges\
\ and Recurring Charges return `NULL`.\n\n\nSee [Usage Rating by Group](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/Usage/Usage_Rating_by_Group)\
\ for more information.\n"
enum:
- ByBillingPeriod
- ByUsageStartDate
- ByUsageRecord
- ByUsageUpload
- ByGroupId
type: string
RevRecCode:
description: " Associates this product rate plan charge with a specific\
\ revenue recognition code.\n\n**Character limit**: 70\n\n**Values**:\
\ inherited from `ProductRatePlanCharge.RevRecCode` or a valid revenue\
\ recognition code\n\n**Note**: Unless overridden, this value changes\
\ if `ProductRatePlanCharge.RevRecCode` is updated. The values of `UpdatedById`\
\ and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevRecCode`\
\ is updated. "
type: string
RevRecTriggerCondition:
description: " Specifies when revenue recognition begins.\n\n**Character\
\ limit**: 22\n\n**Values**: inherited from `ProductRatePlanCharge.RevRecTriggerCondition`\
\ or one of the following:\n\n- `ContractEffectiveDate`\n\n- `ServiceActivationDate`\n\
\n- `CustomerAcceptanceDate`\n\nNote: Unless overridden, this value changes\
\ if `ProductRatePlanCharge.RevRecTriggerCondition` is updated. The values\
\ of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change\
\ when `ProductRatePlanCharge.RevRecTriggerCondition` is updated. "
type: string
RevenueRecognitionRuleName:
description: " Specifies the Revenue Recognition Rule that you want the\
\ Rate Plan Charge to use. This field can be updated when **Status** is\
\ `Draft`. By default, the Revenue Recognition Rule is inherited from\
\ the Product Rate Plan Charge. For Amend calls, you can use this field\
\ only for NewProduct amendments. For Update calls, you can use this field\
\ only to update subscriptions in draft status. Note that if you use this\
\ field to specify a Revenue Recognition Rule for the Rate Plan Charge,\
\ the rule will remain as specified even if you later change the rule\
\ used by the corresponding Product Rate Plan Charge.\n\n**Character limit**:\
\ n/a\n\n**Values**: inherited from `ProductRatePlanCharge.RevenueRecognitionRuleName`\
\ or the name of an active Revenue Recognition Rule\n\n**Note**: Unless\
\ overridden, this value changes if `ProductRatePlanCharge.RevenueRecognitionRuleName`\
\ is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge`\
\ do not change when `ProductRatePlanCharge.RevenueRecognitionRuleName`\
\ is updated. "
type: string
SpecificEndDate:
description: |2
The specific date on which the charge ends, in `yyyy-mm-dd` format.
**Character limit**: 29 **Note**:
- This field is only applicable when the `EndDateCondition` field is set to `SpecificEndDate`.
- If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date.
format: date
type: string
SpecificListPriceBase:
description: 'The number of months for the list price base of the charge.
This field is required if you set the value of the `ListPriceBase` field
to `Per Specific Months`.
**Note**:
- This field is available only if you have the Annual List Price feature enabled.
- The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
'
format: int32
maximum: 200
minimum: 1
type: integer
TriggerDate:
description: " The date when the charge becomes effective and billing begins,\
\ in `yyyy-mm-dd` format. This field is required if the `TriggerEvent`\
\ field value is `SpecificDate`.\n**Character limit**: 29 "
format: date
type: string
TriggerEvent:
description: "Specifies when to start billing the customer for the charge.\n\
\n**Note:** This field can be passed through the Subscribe and Amend calls\
\ and will override the default value set on the Product Rate Plan Charge.\n\
\n**Note:** When the [Update rate plan charge trigger condition?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Settings/Define_Default_Subscription_Settings)\
\ setting is set to `Yes`, this field can be passed through the update()\
\ call and override the previous value. You can use this feature\_to\_\
directly update the trigger condition of a rate plan charge without creating\
\ an order action (or amendment).\_\n\n**Character limit**: 18\n**Values**:\
\ inherited from\n`ProductRatePlanCharge.TriggerEvent` and can be one\
\ of the following values:\n\n\n - `ContractEffective` is the date when\
\ the subscription's contract goes into effect and the charge is ready\
\ to be billed.\n\n - `ServiceActivation` is when the services or products\
\ for a subscription have been activated and the customers have access.\n\
\n - `CustomerAcceptance` is when the customer accepts the services or\
\ products for a subscription.\n\n - `SpecificDate` is valid only on the\
\ RatePlanCharge. When this value is specified, use the `TriggerDate`\
\ field to set the specific date.\n"
type: string
UpToPeriods:
description: "\nSpecifies the length of the period during which the charge\
\ is active. If this period ends before the subscription ends, the charge\
\ ends when this period ends. \n\nThis field can be updated when **Status**\
\ is `Draft`.\n\n**Character limit**: 5\n\n**Values**: inherited from\
\ `ProductRatePlanCharge.UpToPeriods`\n\n**Note:** \n * You must use\
\ this field together with the `UpToPeriodsType` field to specify the\
\ time period. This field is only applicable only when the `EndDateCondition`\
\ field is set to `FixedPeriod`. \n * You can override the value inherited\
\ from the Product Rate Plan Charge, but only when creating a new subscription\
\ or a New Product amendment.\n * Use this field to override the value\
\ in `ProductRatePlanCharge.UpToPeriod`.\n * If you override the value\
\ in this field, enter a whole number between 0 and 65535, exclusive.\n\
\ * If the subscription end date is subsequently changed through a Renewal,\
\ or Terms and Conditions amendment, the charge end date will change accordingly\
\ up to the original period end.\n"
UpToPeriodsType:
description: |2
The period type used to define when the charge ends. This field can be updated when **Status** is `Draft`. **Values**: one of the following:
- `Billing Periods` (default)
- `Days`
- `Weeks`
- `Months`
- `Years`
**Note**:
- You must use this field together with the `UpToPeriods` field to specify the time period.
- This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`.
type: string
WeeklyBillCycleDay:
description: |2
Specifies which day of the week as the bill cycle day (BCD) for the charge.
This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
**Values**: one of the following:
- `Sunday`
- `Monday`
- `Tuesday`
- `Wednesday`
- `Thursday`
- `Friday`
- `Saturday`
type: string
type: object
- $ref: '#/definitions/RatePlanChargeObjectCustomFields'
example:
PriceIncreasePercentage: 10
ProxyModifyRefund:
allOf:
- properties:
ReasonCode:
description: " A code identifying the reason for the transaction. Must be\
\ an existing reason code or empty. If you do not specify a value, Zuora\
\ uses the default reason code.\n**Character limit**: 32 **V****alues**:\
\ a valid reason code "
type: string
Status:
description: |2
The status of the refund.
**Character limit**: 10 **Values**: automatically generated:
- `Canceled`
- `Error`
- `Processed`
- `Processing`
type: string
TransferredToAccounting:
description: |2
Specifies whether or not the object has been transferred to an external accounting system. Use this field for integrations with accounting systems such as NetSuite.
**Character limit**: 10 **Values**: automatically generated:
- `Processing`
- `Yes`
- `Error`
- `Ignore`
type: string
type: object
- $ref: '#/definitions/RefundObjectNSFields'
- $ref: '#/definitions/RefundObjectCustomFields'
example:
Id: 2c93808457d787030157e03198c84918
Status: Canceled
ProxyModifySubscription:
allOf:
- properties:
AccountId:
description: ' This field can be updated when **Status** is `Draft`. The
ID of a valid account ID. '
type: string
AutoRenew:
description: " This field can be updated when **Status** is `Draft`. Indicates\
\ if the subscription automatically renews at the end of the term.\n**Values**:\
\ `true`, `false` "
type: boolean
CancelledDate:
description: " The date of the Amendment object.\n**Values**: inherited\
\ from `Amendment.EffectiveDate` "
format: date
type: string
ContractAcceptanceDate:
description: "The date when the customer accepts the contract.\n\nThis field\
\ can be updated when **Status** is `Pending Acceptance`.\n\n**Note**\
\ : This field is only required in the Subscribe call if the [Require\
\ Customer Acceptance of Orders?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Require_Customer_Acceptance_of_Orders.3F)\
\ setting is set to `Yes`. If this setting is set to `Yes`:\n\n * If the\
\ `ServiceActivationDate` field is required, you must set this field,\
\ `ServiceActivationDate`, and `ContractEffectiveDate` fields in the Subscribe\
\ call to activate a subscription.\n * If the `ServiceActivationDate`\
\ field is not required, you must set both this field and the `ContractEffectiveDate`\
\ field in the Subscribe call to activate a subscription. If you only\
\ set a valid date in the `ContractEffectiveDate` field, the Subscribe\
\ call still returns success, but the subscription is in `Pending Acceptance`\
\ status.\n\nThis field can also be updated when the subscription is still\
\ on version one (has not been amended before) and the [Allow update Subscription\
\ trigger dates?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Allow_update_Subscription_trigger_dates.3F)\
\ setting in Billing Settings is set to `Yes`. \n"
format: date
type: string
ContractEffectiveDate:
description: |
The date when the contract takes effect.
This field can be updated when **Status** is `Draft`.
**Note**: This field is required in the Subscribe call. If you set the value of this field to null and both the ServiceActivationDate and ContractAcceptanceDate fields are not required, the Subscribe call still returns success, but the new subscription is in `DRAFT` status. To activate the subscription, you must set a valid date to this field.
This field can also be updated when the subscription is still on version one (has not been amended before) and the [Allow update Subscription trigger dates?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Allow_update_Subscription_trigger_dates.3F) setting in Billing Settings is set to "Yes".
format: date
type: string
CurrentTermPeriodType:
description: |2
The period type for the current subscription term. This field is used with the CurrentTerm field to specify the current subscription term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
type: string
ExternallyManagedBy:
description: 'An enum field on the Subscription object to indicate the name
of a third-party store. This field is used to represent subscriptions
created through third-party stores.
'
enum:
- Amazon
- Apple
- Google
- Roku
type: string
InitialTerm:
description: " The length of the period for the first subscription term.\
\ This field can be updated when Status is `Draft`.\n**Required**: If\
\ TermType is Termed **Character limit**: 20 **Values**: any valid number. "
format: int32
type: integer
InitialTermPeriodType:
description: |2
The period type for the first subscription term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
**Note**:
- This field can be updated when Status is `Draft`.
- This field is used with the InitialTerm field to specify the initial subscription term.
type: string
InvoiceOwnerId:
description: ' This field can be updated when **Status** is `Draft`. A valid
account ID. '
type: string
IsInvoiceSeparate:
description: " Determines if the subscription is invoiced separately. If\
\ `TRUE`, then all charges for this subscription are collected into the\
\ subscription's own invoice.\n**Values**: `TRUE`, `FALSE `(default) "
type: boolean
Name:
description: |2
The unique identifier of the subscription. If you don't specify a value, then Zuora generates a name automatically. Whether auto-generated or manually specified, the subscription name must be unique. Otherwise an error will occur.
**Character limit**: 100 **Values**: one of the following:
- leave null to automatically generate
- a string of 100 characters or fewer
type: string
Notes:
description: " Use this field to record comments about the subscription.\n\
**Character limit**: 500 **Values**: a string of 500 characters or fewer "
type: string
RenewalSetting:
description: " This field can be updated when **Status** is `Draft`. Specifies\
\ whether a termed subscription will remain termed or change to evergreen\
\ when it is renewed.\n**Required**: If TermType is Termed **Values**:\
\ `RENEW_WITH_SPECIFIC_TERM `(default), `RENEW_TO_EVERGREEN` "
type: string
RenewalTerm:
description: |2
The length of the period for the subscription renewal term. This field can be updated when **Status** is `Draft`. **Required**: If TermType is Termed.
**Character limit**: 20 **Values**: one of the following:
- leave null to default to `0`
- any number
format: int32
type: integer
RenewalTermPeriodType:
description: |2
The period type for the subscription renewal term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
**Note**:
- This field is used with the RenewalTerm field to specify the subscription renewal term.
- This field can be updated when Status is `Draft`.
type: string
ServiceActivationDate:
description: "The date when the subscription is activated. \n\n**Character\
\ limit**: 29\n\nThis field can be updated when **Status** is `Pending\
\ Activation`.\n\n**Note**: This field is only required in the Subscribe\
\ call if the [Require Service Activation of Orders?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Require_Service_Activation_of_Orders.3F)\
\ setting is set to `Yes`. If this setting is set to `Yes`:\n\n * If the\
\ `ContractAcceptanceDate` field is required, you must set this field,\
\ `ContractAcceptanceDate`, and `ContractEffectiveDate` fields in the\
\ Subscribe call to activate a subscription.\n * If the `ContractAcceptanceDate`\
\ field is not required, you must set both this field and the `ContractEffectiveDate`\
\ field in the Subscribe call to activate a subscription. If you only\
\ set a valid date in the `ContractEffectiveDate` field, the Subscribe\
\ call still returns success, but the subscription is in `Pending Activation`\
\ status.\n\nThis field can also be updated when the subscription is still\
\ on version one (has not been amended before) and the [Allow update Subscription\
\ trigger dates?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Allow_update_Subscription_trigger_dates.3F)\
\ setting in Billing Settings is set to \"Yes\". \n"
format: date
type: string
Status:
description: |2
The status of the subscription.
**Character limit**: 18 **Values**: automatically generated **Possible values**: one of the following:
- `Draft`
- `Pending Activation`
- `Pending Acceptance`
- `Active`
- `Cancelled`
- `Expired`
- `Suspended` (This value is in **Limited Availability**.)
type: string
TermStartDate:
description: " This field can be updated when **Status** is `Draft`. The\
\ date when the subscription term begins. If this is a renewal subscription,\
\ then this date is different from the subscription start date.\n**Character\
\ limit**: 29 **Version notes**: -- "
format: date
type: string
TermType:
description: " This field can be updated when **Status** is `Draft`. Indicates\
\ if a subscription is termed or evergreen.\n**Character limit**: 9 **Values**:\
\ `TERMED`, `EVERGREEN` "
type: string
Version:
description: " The version number of the subscription.\n**Values**: automatically\
\ generated "
format: int32
type: integer
type: object
- $ref: '#/definitions/SubscriptionObjectQTFields'
- $ref: '#/definitions/SubscriptionObjectNSFields'
- $ref: '#/definitions/SubscriptionObjectCustomFields'
example:
IsInvoiceSeparate: true
ProxyModifyTaxationItem:
allOf:
- properties:
AccountingCode:
description: ' The Chart of Accounts '
type: string
ExemptAmount:
description: " The calculated tax amount excluded due to the exemption.\n\
**Character limit**: 16 **Values**: a decimal value "
format: double
type: number
Jurisdiction:
description: " The jurisdiction that applies the tax or VAT. This value\
\ is typically a state, province, county, or city.\n**Character limit**:\
\ 32 **Values**: a string of 32 characterrs or fewer "
type: string
LocationCode:
description: " The identifier for the location based on the value of the\
\ `TaxCode` field.\n**Character limit**: 32 **Values**: automatically\
\ generated "
type: string
Name:
description: " The name of the tax rate, such as sales tax or GST. This\
\ name is displayed on invoices.\n**Character limit**: 128 **Values**:\
\ a string of 128 characters or fewer "
type: string
TaxAmount:
description: " The amount of the tax applied to the charge.\n**Character\
\ limit**: 16 **Values**: a decimal value "
format: double
type: number
TaxCode:
description: " The tax code identifies which tax rules and tax rates to\
\ apply to a specific charge.\n**Character limit**: 32 **Values**: a string\
\ of 32 characters or fewer "
type: string
TaxCodeDescription:
description: " The description for the tax code.\n**Character limit**: 255\
\ **Values**: a string of 255 characters or fewer "
type: string
TaxDate:
description: " The date that the tax is applied to the charge, in `yyyy-mm-dd`\
\ format.\n**Character limit**: 29 "
format: date
type: string
TaxRate:
description: " The tax rate applied to the charge.\n**Character limit**:\
\ 16 **Values**: a valid decimal value "
format: double
type: number
TaxRateDescription:
description: " The description of the tax rate.\n**Character limit**: 255\
\ **Values**: a string of 255 characters or fewer "
type: string
TaxRateType:
description: " The type of the tax rate applied to the charge.\n**Character\
\ limit**: 10 **Values**: `Percentage`, `FlatFee` "
type: string
type: object
- $ref: '#/definitions/TaxationItemObjectCustomFields'
ProxyModifyUnitOfMeasure:
properties:
Active:
description: " Indicates if the UOM is available for new product rate plans.\
\ The default value is `true`.\n**Character limit**: 5 **Values**: `true`,\
\ `false ` "
type: boolean
DecimalPlaces:
description: 'The number of digits to the right of the decimal point that
you want to measure for the unit. To use whole numbers only, set this value
to 0. You can''t change this value after this `UOM` is used in any product,
subscription, or usage. **Character limit**: 1 **Values**: an integer between
0 and 9, exclusive '
format: int64
type: integer
DisplayedAs:
description: 'The name of the UOM that you want displayed on invoices. The
default value is the `UomName` field value. **Character limit**: 50 **Values**:
A string of 50 characters or fewer '
type: string
RoundingMode:
description: " Specifies whether to round the UOM value up or down when the\
\ value exceeds the `DecimalPlaces` field value. The default value is `Up`.\n\
**Character limit**: 4 **Values**: `Up`, `Down` "
type: string
UomName:
description: " The name of the UOM, such as license or GB. This name is displayed\
\ in query results and in the web-based UI labels. If you want a different\
\ name to be displayed on invoices, then use the `DisplayedAs` field to\
\ provide the invoice label.\n**Character limit**: 50 **Values**: a string\
\ of 50 characters or fewer "
type: string
type: object
ProxyNoDataResponse:
properties:
done:
description: ''
type: boolean
records:
description: ''
items:
type: object
type: array
size:
description: ''
type: integer
type: object
ProxyUnauthorizedResponse:
properties:
message:
description: |
Error message.
If the error message is "Authentication error", ensure that the `Authorization` request header contains valid authentication credentials, then retry the request. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/) for more information.
If the error message is "Failed to get user info", retry the request.
type: string
type: object
QuoteObjectFields:
description: 'The fields populated for a quote when a quote is sent to Zuora Billing
from Zuora Quote.
'
properties:
OpportunityCloseDate__QT:
description: |
The closing date of the Opportunity.
This field is used in Zuora Reporting Data Sources to report on Subscription metrics.
If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
type: string
OpportunityName__QT:
description: "The unique identifier of the Opportunity. \n\nThis field is\
\ used in the Zuora Reporting Data Sources to report on Subscription metrics.\n\
\nIf the subscription was originated from Zuora Quotes, the value is populated\
\ with the value from Zuora Quotes.\n\n**Character limit**: 100\n"
type: string
QuoteBusinessType__QT:
description: |
The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn.
This field is used in the Zuora Reporting Data Sources to report on Subscription metrics.
If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
**Character limit**: 32
type: string
QuoteNumber__QT:
description: |
The unique identifier of the Quote.
This field is used in the Zuora Reporting Data Sources to report on Subscription metrics.
If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
**Character limit**: 32
type: string
QuoteType__QT:
description: |
The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel.
This field is used in the Zuora Reporting Data Sources to report on Subscription metrics.
If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
**Character limit**: 32
type: string
title: quote
type: object
RatePlan:
properties:
CustomFields:
$ref: '#/definitions/CustomFields'
ProductRatePlanId:
description: |
Internal identifier of the product rate plan that the rate plan
is based on.
type: string
AmendmentSubscriptionRatePlanId:
description: |
ID of the subscription rate plan that will be amended.
This field is required when creating an `UpdateProduct` or `RemoveProduct` type of amendment.
type: string
type: object
RatePlanChargeData:
properties:
RatePlanCharge:
$ref: '#/definitions/RatePlanChargeDataRatePlanCharge'
RatePlanChargeTier:
description: ''
items:
$ref: '#/definitions/RatePlanChargeTier'
type: array
required:
- RatePlanCharge
type: object
RatePlanChargeDataInRatePlanData:
properties:
RatePlanCharge:
allOf:
- description: ''
properties:
AccountingCode:
description: "The accounting code for the charge. Accounting codes group\
\ transactions that contain similar accounting attributes.\n\n**Character\
\ limit**: 100\n\n\n**Values**: inherited from `ProductRatePlanCharge.AccountingCode` "
type: string
ApplyDiscountTo:
description: " Specifies the type of charges a specific discount applies\
\ to.\n\n**Character limit**: 21\n\n\n**Values**: inherited from `ProductRatePlanCharge.ApplyDiscountTo` "
type: string
BillCycleDay:
description: " Indicates the charge's billing cycle day (BCD), which\
\ is when bill runs generate invoices for charges associated with\
\ the product rate plan charge or the account.\n\n\n**Character limit**:\
\ 2\n\n\n**Values**: inherited from `ProductRatePlanCharge.BillCycleDay` "
format: int32
type: integer
BillCycleType:
description: " Specifies how to determine the billing day for the charge.\n\
\n\n**Character limit**: 20\n\n\n**Values**: inherited from `ProductRatePlanCharge.BillCycleType`\
\ **Note:** You can override the value inherited from the Product\
\ Rate Plan Charge, but only when creating a new subscription or a\
\ New Product amendment. "
type: string
BillingPeriod:
description: " Allows billing period to be overridden on rate plan charge.\n\
\n\n\n**Values**: inherited from `ProductRatePlanCharge.BillingPeriod`\
\ **Note:** You can override the value inherited from the Product\
\ Rate Plan Charge, but only when creating a new subscription or a\
\ New Product amendment. "
type: string
BillingPeriodAlignment:
description: " Aligns charges within the same subscription if multiple\
\ charges begin on different dates.\n\n\n**Character limit**: 24\n\
\n\n**Values**: inherited from `ProductRatePlanCharge.BillingPeriodAlignment` "
type: string
BillingTiming:
description: |2+
The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types.
**Character limit**:
**Values**: one of the following:
- `In Advance`
- `In Arrears`
**Note:** You can override the value inherited from the Product Rate Plan Charge when a subscription has a recurring charge type.
type: string
ChargeModel:
description: " Determines how to evaluate charges. Charge models must\
\ be individually activated in the web-based UI.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: inherited from `ProductRatePlanCharge.ChargeModel` "
type: string
ChargeNumber:
description: |2
A unique number that identifies the charge. This number is returned as a string.
**Character limit**: 50
**Values**: one of the following:
- automatically generated if left null
- a unique number of 50 characters or fewer
type: string
ChargeType:
description: " Specifies the type of charge.\n\n\n**Character limit**:\
\ 9\n\n\n**Values**: inherited from `ProductRatePlanCharge.ChargeType` "
type: string
ChargedThroughDate:
description: " The date through which a customer has been billed for\
\ the charge.\n\n\n**Character limit**: 29\n\n\n**Values**: automatically\
\ generated "
format: date
type: string
CreatedById:
description: "The ID of the Zuora user who created the `RatePlanCharge`\
\ object.\n\n**Character limit**: 32\n\n\n**Values**: automatically\
\ generated "
type: string
CreatedDate:
description: " The date when the `RatePlanCharge` object was created.\n\
\n\n**Character limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
DMRC:
description: "A delta monthly recurring charge is the change in monthly\
\ recurring revenue caused by an amendment or a new subscription.\n\
\n**Character limit**: 16\n\n\n**Values**: automatically generated "
format: double
type: number
DTCV:
description: " After an Amendment, the change in the total contract\
\ value (TCV) amount for this charge, compared with its previous value.\n\
\n\n**Character limit**: 16\n\n\n**Values**: automatically generated "
format: double
type: number
Description:
description: " A description of the charge.\n\n\n**Character limit**:\
\ 500\n\n\n**Values**: inherited from `ProductRatePlanCharge.Description` "
type: string
DiscountAmount:
description: " Specifies the amount of a fixed-amount discount. You\
\ can provide a value for this field if the `ChargeModel` field value\
\ is `Discount-Fixed Amount`. If this field is included in a query,\
\ the query will filter out the rate plans whose `ChargeModel` field\
\ is not of a Discount type. You cannot query this field with the\
\ following fields in a single query:\n\n- Price\n- IncludedUnits\n\
- DiscountPercentage\n- OveragePrice\n\n\n**Character limit**: 16\n\
\n\n**Values**: a valid currency amount "
format: double
type: number
DiscountLevel:
description: "Specifies if the discount applies to just the product\
\ rate plan, the entire subscription, or to any activity in the account.\
\ This field is only required if the `ChargeModel` field is set to\
\ `DiscountFixedAmount` or `DiscountPercentage`.\n\n**Character limit**:\
\ 12\n\n\n**Values**: inherited from `ProductRatePlanCharge.DiscountLevel` "
type: string
DiscountPercentage:
description: ' Query Filter '
format: double
type: number
EffectiveEndDate:
description: " The date when the segmented charge ends or ended.\n\n\
\n**Character limit**: 16\n\n\n**Values**: automatically generated "
format: date
type: string
EffectiveStartDate:
description: " The date when the segmented charge starts or started.\n\
\n\n**Character limit**: 16\n\n\n**Values**: automatically generated "
format: date
type: string
EndDateCondition:
description: " Defines when the charge ends after the charge trigger\
\ date. This field can be updated when **Status** is `Draft`.\n\n\n\
\n**Values**: one of the following:\n\n- `SubscriptionEnd`: The charge\
\ ends on the subscription end date after the charge trigger date.\
\ This is the default value.\n- `FixedPeriod`: The charge ends after\
\ a specified period based on the trigger date of the charge. If you\
\ set this field to `FixedPeriod`, you must specify the length of\
\ the period and a period type by defining the `UpToPeriods` and `UpToPeriodsType`\
\ fields.\n- `SpecificEndDate`: The specific date on which the charge\
\ ends. If you set this field to `SpecificEndDate`, you must specify\
\ the specific date by defining the `SpecificEndDate` field.\n\n\n\
\n**Note**: If the subscription ends before the charge end date, the\
\ charge ends when the subscription ends. But if the subscription\
\ end date is subsequently changed through a Renewal, or Terms and\
\ Conditions amendment, the charge will end on the charge end date. "
type: string
IncludedUnits:
description: ' Query Filter '
format: double
type: number
IsLastSegment:
description: "Indicates if the segment of the rate plan charge is the\
\ most recent segment.\n\n**Character limit**: 5\n\n\n**Values**:\
\ automatically generated: `true`, `false` "
type: boolean
ListPriceBase:
description: |
The list price base for the product rate plan charge.
You can only change the value of this field if the amendment type is NewProduct.
enum:
- Per Month
- Per Billing Period
- Per Week
- Per Year
- Per Specific Months
type: string
MRR:
description: "Monthly recurring revenue (MRR) is the amount of recurring\
\ charges in a given month. The MRR calculation doesn't include one-time\
\ charges nor usage charges.\n\n**Character limit**: 16\n\n\n**Values**:\
\ automatically generated "
format: double
type: number
Name:
description: "The name of the rate plan charge.\n\n**Character limit**:\
\ 100\n\n\n**Values**: automatically generated "
type: string
NumberOfPeriods:
description: "Specifies the number of periods to use when calculating\
\ charges in an overage smoothing charge model.\n\n**Character limit**:\
\ 5\n\n\n**Values**: inherited from `ProductRatePlanCharge.NumberOfPeriod` "
format: int64
type: integer
OriginalId:
description: "The original ID of the rate plan charge.\n\n**Character\
\ limit**: 32\n\n\n**Values**: automatically generated "
type: string
OverageCalculationOption:
description: "Determines when to calculate overage charges. If the value\
\ of the SmoothingMode field is null (not specified and not inherited\
\ from ProductRatePlanCharge.SmoothingMode), the value of this field\
\ is ignored.\n\n**Character limit**: 20\n\n\n**Values**: inherited\
\ from `ProductRatePlanCharge.OverageCalculationOption` "
type: string
OveragePrice:
description: ' Query Filter '
format: double
type: number
OverageUnusedUnitsCreditOption:
description: " Determines whether to credit the customer with unused\
\ units of usage.\n\n\n**Character limit**: 20\n\n\n**Values**: inherited\
\ from `ProductRatePlanCharge.OverageUnusedUnitsCreditOption` "
type: string
Price:
description: ' Query Filter '
format: double
type: number
PriceChangeOption:
description: |2
Applies an automatic price change when a termed subscription is renewed.
**Character limit**:
**Values**: one of the following:
- `NoChange` (default)
- `SpecificPercentageValue`
- `UseLatestProductCatalogPricing`
type: string
PriceIncreasePercentage:
description: " Specifies the percentage to increase or decrease the\
\ price of renewed subscriptions. Use this field if the `ProductRatePlanCharge`.`PriceChangeOption`\
\ value is set to `SpecificPercentageValue`.\n\n\n**Character limit**:\
\ 16\n\n\n**Values**: a decimal value between -100 and 100 "
format: double
type: number
ProcessedThroughDate:
description: " The date until when charges have been processed. When\
\ billing in arrears, such as usage, this field value is the the same\
\ as the `ChargedThroughDate` value. This date is the earliest date\
\ when a charge can be amended.\n\n\n**Character limit**: 29\n\n\n\
**Values**: automatically generated "
format: date
type: string
ProductRatePlanChargeId:
description: " The ID of the product rate plan charge associated with\
\ the subscription rate plan charge,\n\n**Character limit**: 32\n\n\
\n**Values**: inherited from `ProductRatePlanCharge.Id` "
type: string
Quantity:
description: " The default quantity of units, such as the number of\
\ authors in a hosted wiki service. Valid for all charge models except\
\ for Flat Fee pricing. This field is only rquired if the charge model\
\ is per unit, tiered pricing, or volume pricing.\n\n\n\n**Character\
\ limit**: 16\n\n\n**Values**: a valid quantity value "
format: double
type: number
RatePlanId:
description: " The ID of the rate plan associated with the rate plan\
\ charge.\n\n\n**Character limit**: 32\n\n\n**Values**: inherited\
\ from `RatePlan.Id` "
type: string
RevRecCode:
description: " Associates this product rate plan charge with a specific\
\ revenue recognition code.\n\n\n**Character limit**: 70\n\n\n**Values**:\
\ a valid revenue recognition code "
type: string
RevRecTriggerCondition:
description: |2+
Specifies when revenue recognition begins.
**Character limit**: 22
**Values**: one of the following:
- `ContractEffectiveDate`
- `ServiceActivationDate`
- `CustomerAcceptanceDate`
type: string
RevenueRecognitionRuleName:
description: " Specifies the Revenue Recognition Rule that you want\
\ the Rate Plan Charge to use. This field can be updated when **Status**\
\ is `Draft`. By default, the Revenue Recognition Rule is inherited\
\ from the Product Rate Plan Charge. For Amend\ncalls, you can use\
\ this field only for NewProduct amendments. For Update\ncalls, you\
\ can use this field only to update subscriptions in draft status.\
\ Note that if you use this field to specify a Revenue Recognition\
\ Rule for the Rate Plan Charge, the rule will remain as specified\
\ even if you later change the rule used by the corresponding Product\
\ Rate Plan Charge. See [Z-Billing User Role](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\
\ permission enabled to use this field.\n\n\n\n**Character limit**:\
\ n/a\n\n\n**Values**: name of an active Revenue Recognition Rule "
type: string
RolloverBalance:
description: |2
Specifies the number of units of measure (UOM) rolled over from previous periods. This field is applicable only to usage charges with overage models.
**Character limit**: 16
**Values**: automatically generated
**Note**:
- You cannot query or filter this field with other fields in a single query.
- To query or filter this field, you must specify and only specify the rate plan charge Id in the condition.
- You cannot use this field in the query or filter condition.
format: double
type: number
Segment:
description: " The identifying number of the subscription rate plan\
\ segment. Segments are numbered sequentially, starting with 1.\n\n\
\n**Character limit**: 2\n\n\n**Values**: automatically generated "
format: int32
type: integer
SpecificBillingPeriod:
description: " Customizes the number of months or weeks for the charges\
\ billing period. This field is only required if you set the value\
\ of the `BillingPeriod` field to `Specific Months` or `Specific Weeks`.\n\
\n\n**Character limit**: 5\n\n\n**Values**: inherited from `ProductRatePlanCharge.BillingPeriod`\
\ **Note:** You can override the value inherited from the Product\
\ Rate Plan Charge, but only when creating a new subscription or a\
\ New Product amendment. "
format: int64
type: integer
SpecificEndDate:
description: |2
The specific date on which the charge ends, in `yyyy-mm-dd` format.
**Character limit**: 29
**Note**:
- This field is only applicable when the `EndDateCondition` field is set to `SpecificEndDate`.
- If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date.
format: date
type: string
SpecificListPriceBase:
description: 'The number of months for the list price base of the charge.
This field is required if you set the value of the `ListPriceBase`
field to `Per Specific Months`.
**Note**:
- This field is available only if you have the Annual List Price feature enabled.
- The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
'
format: int32
maximum: 200
minimum: 1
type: integer
TCV:
description: " The total contract value (TCV) is the value of a single\
\ rate plan charge in a subscription over the lifetime of the subscription.\
\ This value does not represent all charges on the subscription. The\
\ TCV includes recurring charges and one-time charges, but it doesn't\
\ include usage charge.\n\n\n**Character limit**: 16\n\n\n**Values**:\
\ automatically generated "
format: double
type: number
TriggerDate:
description: |2+
The date when the charge becomes effective and billing begins, in `yyyy-mm-dd` format. This field is only required if the `TriggerEvent` field is set to `SpecificDate`.
**Character limit**: 29
format: date
type: string
TriggerEvent:
description: |2
Specifies when to start billing the customer for the charge.
**Note: **This field can be passed through the subscribe
and amend
calls and will override the default value set on the Product Rate Plan Charge.
**Character limit**: 18
**Values**: inherited from `ProductRatePlanCharge.TriggerEvent` and can be one of the following values:
- `ContractEffective `is the date when the subscription's contract goes into effect and the charge is ready to be billed.
- `ServiceActivationDate `is when the services or products for a subscription have been activated and the customers have access.
- `CustomerAcceptance `is when the customer accepts the services or products for a subscription.
- SpecificDate is valid only on the RatePlanCharge.
type: string
UOM:
description: " Specifies the units to measure usage. Units of measure\
\ are configured in the web-based UI: **Z-Billing > Settings**.\n\n\
\n**Character limit**: 25\n\n\n**Values**: inherited from `ProductRatePlanCharge.UOM` "
type: string
UnusedUnitsCreditRates:
description: " Specifies the rate to credit a customer for unused units\
\ of usage. This field is applicable only for overage charge models\
\ when the `OverageUnusedUnitsCreditOption` field value is CreditBySpecificRate.\n\
\n\n**Character limit**: 16\n\n\n**Values**: a valid decimal value "
format: double
type: number
UpToPeriods:
description: |2
Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.
**Character limit**: 5
**Values**: inherited from `ProductRatePlanCharge.UpToPeriods`
**Note**:
- You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`.
- You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment.
- Use this field to override the value in `ProductRatePlanCharge.UpToPeriod`.
- If you override the value in this field, enter a whole number between 0 and 65535, exclusive.
- If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.
format: int64
type: integer
UpToPeriodsType:
description: |2
The period type used to define when the charge ends. This field can be updated when **Status** is `Draft`.
**Values**: one of the following:
- `Billing Periods` (default)
- `Days`
- `Weeks`
- `Months`
- `Years`
**Note**:
- You must use this field together with the `UpToPeriods` field to specify the time period.
- This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`.
type: string
UpdatedById:
description: "The ID of the last user to update the object.\n\n**Character\
\ limit**: 32\n\n\n**Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the object was last updated.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
UsageRecordRatingOption:
description: " Determines how Zuora processes usage records for per-unit\
\ usage charges.\n\n**Character limit**: 18\n\n\n**Values**: automatically\
\ generated "
type: string
UseDiscountSpecificAccountingCode:
description: " Determines whether to define a new accounting code for\
\ the new discount charge.\n\n\n**Character limit**: 5\n\n\n**Values**:\
\ inherited from `ProductRatePlanCharge.UseDiscountSpecificAccountingCode` "
type: boolean
Version:
description: " The version of the rate plan charge. Each time a charge\
\ is amended, Zuora creates a new version of the rate plan charge.\n\
\n**Character limit**: 5\n\n\n**Values**: automatically generated "
format: int64
type: integer
WeeklyBillCycleDay:
description: |2
Specifies which day of the week as the bill cycle day (BCD) for the charge.
This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
**Values**: one of the following:
- `Sunday`
- `Monday`
- `Tuesday`
- `Wednesday`
- `Thursday`
- `Friday`
- `Saturday`
type: string
required:
- ProductRatePlanChargeId
type: object
- $ref: '#/definitions/SubscriptionObjectCustomFields'
RatePlanChargeTier:
description: ''
items:
$ref: '#/definitions/RatePlanChargeTier'
type: array
required:
- RatePlanCharge
title: RatePlanChargeData
type: object
RatePlanChargeDataRatePlanCharge:
allOf:
- properties:
AccountingCode:
description: "The accounting code for the charge. Accounting codes group\
\ transactions that contain similar accounting attributes.\n\n**Character\
\ limit**: 100\n\n\n**Values**: inherited from `ProductRatePlanCharge.AccountingCode` "
type: string
ApplyDiscountTo:
description: " Specifies the type of charges a specific discount applies\
\ to.\n\n**Character limit**: 21\n\n\n**Values**: inherited from `ProductRatePlanCharge.ApplyDiscountTo` "
type: string
BillCycleDay:
description: " Indicates the charge's billing cycle day (BCD), which is\
\ when bill runs generate invoices for charges associated with the product\
\ rate plan charge or the account.\n\n\n**Character limit**: 2\n\n\n**Values**:\
\ inherited from `ProductRatePlanCharge.BillCycleDay` "
format: int32
type: integer
BillCycleType:
description: " Specifies how to determine the billing day for the charge.\n\
\n\n**Character limit**: 20\n\n\n**Values**: inherited from `ProductRatePlanCharge.BillCycleType`\
\ **Note:** You can override the value inherited from the Product Rate\
\ Plan Charge, but only when creating a new subscription or a New Product\
\ amendment. "
type: string
BillingPeriod:
description: " Allows billing period to be overridden on rate plan charge.\n\
\n\n\n**Values**: inherited from `ProductRatePlanCharge.BillingPeriod`\
\ **Note:** You can override the value inherited from the Product Rate\
\ Plan Charge, but only when creating a new subscription or a New Product\
\ amendment. "
type: string
BillingPeriodAlignment:
description: " Aligns charges within the same subscription if multiple charges\
\ begin on different dates.\n\n\n**Character limit**: 24\n\n\n**Values**:\
\ inherited from `ProductRatePlanCharge.BillingPeriodAlignment` "
type: string
BillingTiming:
description: |2+
The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types.
**Character limit**:
**Values**: one of the following:
- I`n Advance`
- `In Arrears`
**Note:** You can override the value inherited from the Product Rate Plan Charge when a subscription has a recurring charge type.
This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
type: string
ChargeModel:
description: " Determines how to evaluate charges. Charge models must be\
\ individually activated in the web-based UI.\n\n\n**Character limit**:\
\ 29\n\n\n**Values**: inherited from `ProductRatePlanCharge.ChargeModel` "
type: string
ChargeNumber:
description: |2
A unique number that identifies the charge. This number is returned as a string.
**Character limit**: 50
**Values**: one of the following:
- automatically generated if left null
- a unique number of 50 characters or fewer
type: string
ChargeType:
description: " Specifies the type of charge.\n\n\n**Character limit**: 9\n\
\n\n**Values**: inherited from `ProductRatePlanCharge.ChargeType` "
type: string
ChargedThroughDate:
description: " The date through which a customer has been billed for the\
\ charge.\n\n\n**Character limit**: 29\n\n\n**Values**: automatically\
\ generated "
format: date
type: string
CreatedById:
description: "The ID of the Zuora user who created the `RatePlanCharge`\
\ object.\n\n**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the `RatePlanCharge` object was created.\n\n\
\n**Character limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
DMRC:
description: "A delta monthly recurring charge is the change in monthly\
\ recurring revenue caused by an amendment or a new subscription.\n\n\
**Character limit**: 16\n\n\n**Values**: automatically generated "
format: double
type: number
DTCV:
description: " After an Amendment, the change in the total contract value\
\ (TCV) amount for this charge, compared with its previous value.\n\n\n\
**Character limit**: 16\n\n\n**Values**: automatically generated "
format: double
type: number
Description:
description: " A description of the charge.\n\n\n**Character limit**: 500\n\
\n\n**Values**: inherited from `ProductRatePlanCharge.Description` "
type: string
DiscountAmount:
description: " Specifies the amount of a fixed-amount discount. You can\
\ provide a value for this field if the `ChargeModel` field value is `Discount-Fixed\
\ Amount`. If this field is included in a query, the query will filter\
\ out the rate plans whose `ChargeModel` field is not of a Discount type.\
\ You cannot query this field with the following fields in a single query:\n\
\n- Price\n- IncludedUnits\n- DiscountPercentage\n- OveragePrice\n\n\n\
**Character limit**: 16\n\n\n**Values**: a valid currency amount "
format: double
type: number
DiscountLevel:
description: "Specifies if the discount applies to just the product rate\
\ plan, the entire subscription, or to any activity in the account. This\
\ field is only required if the `ChargeModel` field is set to `DiscountFixedAmount`\
\ or `DiscountPercentage`.\n\n**Character limit**: 12\n\n\n**Values**:\
\ inherited from `ProductRatePlanCharge.DiscountLevel` "
type: string
DiscountPercentage:
description: ' Query Filter '
format: double
type: number
EffectiveEndDate:
description: " The date when the segmented charge ends or ended.\n\n\n**Character\
\ limit**: 16\n\n\n**Values**: automatically generated "
format: date
type: string
EffectiveStartDate:
description: " The date when the segmented charge starts or started.\n\n\
\n**Character limit**: 16\n\n\n**Values**: automatically generated "
format: date
type: string
EndDateCondition:
description: " Defines when the charge ends after the charge trigger date.\
\ This field can be updated when **Status** is `Draft`.\n\n\n\n**Values**:\
\ one of the following:\n\n- `SubscriptionEnd`: The charge ends on the\
\ subscription end date after the charge trigger date. This is the default\
\ value.\n- `FixedPeriod`: The charge ends after a specified period based\
\ on the trigger date of the charge. If you set this field to `FixedPeriod`,\
\ you must specify the length of the period and a period type by defining\
\ the `UpToPeriods` and `UpToPeriodsType` fields.\n- `SpecificEndDate`:\
\ The specific date on which the charge ends. If you set this field to\
\ `SpecificEndDate`, you must specify the specific date by defining the\
\ `SpecificEndDate` field.\n\n\n\n**Note**: If the subscription ends before\
\ the charge end date, the charge ends when the subscription ends. But\
\ if the subscription end date is subsequently changed through a Renewal,\
\ or Terms and Conditions amendment, the charge will end on the charge\
\ end date. "
type: string
IncludedUnits:
description: ' Query Filter '
format: double
type: number
IsLastSegment:
description: "Indicates if the segment of the rate plan charge is the most\
\ recent segment.\n\n**Character limit**: 5\n\n\n**Values**: automatically\
\ generated: `true`, `false` "
type: boolean
ListPriceBase:
description: |
The list price base for the product rate plan charge.
enum:
- Per Month
- Per Billing Period
- Per Week
- Per Year
- Per Specific Months
type: string
MRR:
description: "Monthly recurring revenue (MRR) is the amount of recurring\
\ charges in a given month. The MRR calculation doesn't include one-time\
\ charges nor usage charges.\n\n**Character limit**: 16\n\n\n**Values**:\
\ automatically generated "
format: double
type: number
Name:
description: "The name of the rate plan charge.\n\n**Character limit**:\
\ 100\n\n\n**Values**: automatically generated "
type: string
NumberOfPeriods:
description: "Specifies the number of periods to use when calculating charges\
\ in an overage smoothing charge model.\n\n**Character limit**: 5\n\n\n\
**Values**: inherited from `ProductRatePlanCharge.NumberOfPeriod` "
format: int64
type: integer
OriginalId:
description: "The original ID of the rate plan charge.\n\n**Character limit**:\
\ 32\n\n\n**Values**: automatically generated "
type: string
OverageCalculationOption:
description: "Determines when to calculate overage charges. If the value\
\ of the SmoothingMode field is null (not specified and not inherited\
\ from ProductRatePlanCharge.SmoothingMode), the value of this field is\
\ ignored.\n\n**Character limit**: 20\n\n\n**Values**: inherited from\
\ `ProductRatePlanCharge.OverageCalculationOption` "
type: string
OveragePrice:
description: ' Query Filter '
format: double
type: number
OverageUnusedUnitsCreditOption:
description: " Determines whether to credit the customer with unused units\
\ of usage.\n\n\n**Character limit**: 20\n\n\n**Values**: inherited from\
\ `ProductRatePlanCharge.OverageUnusedUnitsCreditOption` "
type: string
Price:
description: ' Query Filter '
format: double
type: number
PriceChangeOption:
description: |2
Applies an automatic price change when a termed subscription is renewed.
**Character limit**:
**Values**: one of the following:
- `NoChange` (default)
- `SpecificPercentageValue`
- `UseLatestProductCatalogPricing`
type: string
PriceIncreasePercentage:
description: " Specifies the percentage to increase or decrease the price\
\ of renewed subscriptions. Use this field if the `ProductRatePlanCharge`.`PriceChangeOption`\
\ value is set to `SpecificPercentageValue`.\n\n\n**Character limit**:\
\ 16\n\n\n**Values**: a decimal value between -100 and 100 "
format: double
type: number
ProcessedThroughDate:
description: " The date until when charges have been processed. When billing\
\ in arrears, such as usage, this field value is the the same as the `ChargedThroughDate`\
\ value. This date is the earliest date when a charge can be amended.\n\
\n\n**Character limit**: 29\n\n\n**Values**: automatically generated "
format: date
type: string
ProductRatePlanChargeId:
description: " The ID of the product rate plan charge associated with the\
\ subscription rate plan charge,\n\n**Character limit**: 32\n\n\n**Values**:\
\ inherited from `ProductRatePlanCharge.Id` "
type: string
Quantity:
description: " The default quantity of units, such as the number of authors\
\ in a hosted wiki service. Valid for all charge models except for Flat\
\ Fee pricing. This field is only rquired if the charge model is tiered\
\ pricing or volume pricing.\n\n\n**Character limit**: 16\n\n\n**Values**:\
\ a valid quantity value "
format: double
type: number
RatePlanId:
description: " The ID of the rate plan associated with the rate plan charge.\n\
\n\n**Character limit**: 32\n\n\n**Values**: inherited from `RatePlan.Id` "
type: string
RevRecCode:
description: " Associates this product rate plan charge with a specific\
\ revenue recognition code.\n\n\n**Character limit**: 70\n\n\n**Values**:\
\ a valid revenue recognition code "
type: string
RevRecTriggerCondition:
description: |2+
Specifies when revenue recognition begins.
**Character limit**: 22
**Values**: one of the following:
- `ContractEffectiveDate`
- `ServiceActivationDate`
- `CustomerAcceptanceDate`
type: string
RevenueRecognitionRuleName:
description: " Specifies the Revenue Recognition Rule that you want the\
\ Rate Plan Charge to use. This field can be updated when **Status** is\
\ `Draft`. By default, the Revenue Recognition Rule is inherited from\
\ the Product Rate Plan Charge. For Amend\ncalls, you can use this field\
\ only for NewProduct amendments. For Update\ncalls, you can use this\
\ field only to update subscriptions in draft status. Note that if you\
\ use this field to specify a Revenue Recognition Rule for the Rate Plan\
\ Charge, the rule will remain as specified even if you later change the\
\ rule used by the corresponding Product Rate Plan Charge. See [Z-Billing\
\ User Role](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\
\ permission enabled to use this field.\n\n\n\n**Character limit**: n/a\n\
\n\n**Values**: name of an active Revenue Recognition Rule "
type: string
RolloverBalance:
description: |2
Specifies the number of units of measure (UOM) rolled over from previous periods. This field is applicable only to usage charges with overage models.
**Character limit**: 16
**Values**: automatically generated
**Note**:
- You cannot query or filter this field with other fields in a single query.
- To query or filter this field, you must specify and only specify the rate plan charge Id in the condition.
- You cannot use this field in the query or filter condition.
format: double
type: number
Segment:
description: " The identifying number of the subscription rate plan segment.\
\ Segments are numbered sequentially, starting with 1.\n\n\n**Character\
\ limit**: 2\n\n\n**Values**: automatically generated "
format: int32
type: integer
SpecificBillingPeriod:
description: " Customizes the number of months or weeks for the charges\
\ billing period. This field is only required if you set the value of\
\ the `BillingPeriod` field to `Specific Months` or `Specific Weeks`.\n\
\n**Character limit**: 5\n\n\n**Values**: inherited from `ProductRatePlanCharge.BillingPeriod`\
\ **Note:** You can override the value inherited from the Product Rate\
\ Plan Charge, but only when creating a new subscription or a New Product\
\ amendment. "
format: int64
type: integer
SpecificEndDate:
description: |2
The specific date on which the charge ends, in `yyyy-mm-dd` format.
**Character limit**: 29
**Note**:
- This field is only applicable when the `EndDateCondition` field is set to `SpecificEndDate`.
- If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date.
format: date
type: string
SpecificListPriceBase:
description: |
The number of months for the list price base of the charge.
This field is required if you set the value of the `ListPriceBase` field
to `Per Specific Months`.
**Note**:
- This field is available only if you have the Annual List Price feature enabled.
- The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
format: int32
maximum: 200
minimum: 1
type: integer
TCV:
description: " The total contract value (TCV) is the value of a single rate\
\ plan charge in a subscription over the lifetime of the subscription.\
\ This value does not represent all charges on the subscription. The TCV\
\ includes recurring charges and one-time charges, but it doesn't include\
\ usage charge.\n\n\n**Character limit**: 16\n\n\n**Values**: automatically\
\ generated "
format: double
type: number
TriggerDate:
description: |2+
The date when the charge becomes effective and billing begins, in `yyyy-mm-dd` format. This field is only required if the `TriggerEvent` field is set to `SpecificDate`.
**Character limit**: 29
format: date
type: string
TriggerEvent:
description: |2
Specifies when to start billing the customer for the charge.
**Note: **This field can be passed through the subscribe
and amend
calls and will override the default value set on the Product Rate Plan Charge.
**Character limit**: 18
**Values**: inherited from `ProductRatePlanCharge.TriggerEvent` and can be one of the following values:
- `ContractEffective`is the date when the subscription's contract goes into effect and the charge is ready to be billed. When previewing invoices with the subscribe call, if a charge's trigger event is set to `ContractEffective`, you must also set the `subscribes` > `SubscriptionData` > `Subscription` > `ContractEffectiveDate` field to a specific date to complete your preview. You cannot leave this field as blank.
- `ServiceActivation`is when the services or products for a subscription have been activated and the customers have access. When previewing invoices with the subscribe call, if a charge's trigger event is set to `ServiceActivation`, you must also set the `subscribes` > `SubscriptionData` > `Subscription` > `ServiceActivationDate` field to a specific date to complete your preview. You cannot leave this field as blank.
- `CustomerAcceptance`is when the customer accepts the services or products for a subscription. When previewing invoices with the subscribe call, if a charge's trigger event is set to `CustomerAcceptance`, you must also set the `subscribes` > `SubscriptionData` > `Subscription` > `CustomerAcceptanceDate` field to a specific date to complete your preview. You cannot leave this field as blank.
- `SpecificDate` is valid only on the RatePlanCharge.
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\n**Character\
\ limit**: 25\n\n\n**Values**: inherited from `ProductRatePlanCharge.UOM` "
type: string
UnusedUnitsCreditRates:
description: " Specifies the rate to credit a customer for unused units\
\ of usage. This field is applicable only for overage charge models when\
\ the `OverageUnusedUnitsCreditOption` field value is CreditBySpecificRate.\n\
\n\n**Character limit**: 16\n\n\n**Values**: a valid decimal value "
format: double
type: number
UpToPeriods:
description: |2
Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.
**Character limit**: 5
**Values**: inherited from `ProductRatePlanCharge.UpToPeriods`
**Note**:
- You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`.
- You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment.
- Use this field to override the value in `ProductRatePlanCharge.UpToPeriod`.
- If you override the value in this field, enter a whole number between 0 and 65535, exclusive.
- If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.
format: int64
type: integer
UpToPeriodsType:
description: |2
The period type used to define when the charge ends. This field can be updated when **Status** is `Draft`.
**Values**: one of the following:
- `Billing Periods` (default)
- `Days`
- `Weeks`
- `Months`
- `Years`
**Note**:
- You must use this field together with the `UpToPeriods` field to specify the time period.
- This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`.
type: string
UpdatedById:
description: "The ID of the last user to update the object.\n\n**Character\
\ limit**: 32\n\n\n**Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the object was last updated.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
UsageRecordRatingOption:
description: " Determines how Zuora processes usage records for per-unit\
\ usage charges.\n\n**Character limit**: 18\n\n\n**Values**: automatically\
\ generated "
type: string
UseDiscountSpecificAccountingCode:
description: " Determines whether to define a new accounting code for the\
\ new discount charge.\n\n\n**Character limit**: 5\n\n\n**Values**: inherited\
\ from `ProductRatePlanCharge.UseDiscountSpecificAccountingCode` "
type: boolean
Version:
description: " The version of the rate plan charge. Each time a charge is\
\ amended, Zuora creates a new version of the rate plan charge.\n\n**Character\
\ limit**: 5\n\n\n**Values**: automatically generated "
format: int64
type: integer
WeeklyBillCycleDay:
description: |2
Specifies which day of the week as the bill cycle day (BCD) for the charge.
This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
**Values**: one of the following:
- `Sunday`
- `Monday`
- `Tuesday`
- `Wednesday`
- `Thursday`
- `Friday`
- `Saturday`
type: string
required:
- ProductRatePlanChargeId
type: object
- $ref: '#/definitions/RatePlanChargeObjectCustomFields'
description: ''
title: RatePlanCharge
RatePlanChargeObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Rate Plan Charge 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 a Rate Plan Charge object.
'
title: ratePlanChargeFieldsCustom
type: object
RatePlanChargeTier:
properties:
CreatedById:
description: "The ID of the Zuora user who created the RatePlanChargeTier\
\ object.\n\n**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the RatePlanChargeTier object was created.\n\n\
\n**Character limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
EndingUnit:
description: " The end number of a range of units for the tier. This field\
\ is only required if the charge mode is `Tiered Pricing` or `Tierred with\
\ Overage Pricing`.\n\n\n**Character limit**: 16\n\n\n**Values**: any positive\
\ decimal value "
format: double
type: number
IsOveragePrice:
description: " Indicates if the price is an overage price. An overage occurs\
\ when usage surpasses the last defined tier. This field is applicable only\
\ to tier pricing and volume pricing models.\n\n\n\n**Values**: true, false "
type: boolean
Price:
description: " The price of the tier if the charge is a flat fee, or the price\
\ of each unit in the tier if the change model is tiered pricing.\n\n\n\
**Character limit**: 16\n\n\n**Values**: any positive decimal value "
format: double
type: number
PriceFormat:
description: " Indicates if the price is a flat fee or is per unit.\n\n\n\
**Character limit**: 8\n\n\n**Values**: `FlatFee`, `PerUnit` "
enum:
- FlatFee
- PerUnit
type: string
RatePlanChargeId:
description: " The ID of the subscription or amendment rate plan charge associated\
\ with this tier. You can't create an unassociated tier.\n\n\n**Character\
\ limit**: 32\n\n\n**Values**: inherited from `RatePlanCharge`.`Id` "
type: string
StartingUnit:
description: " The start number of a range of units for the tier. This field\
\ is only required if the charge mode is `Tiered Pricing` or `Tierred with\
\ Overage Pricing`.\n\n\n**Character limit**: 16\n\n\n**Values**: any positive\
\ decimal value "
format: double
type: number
Tier:
description: " A unique number that identifies the tier that the price applies\
\ to.\n\n\n**Character limit**: 20\n\n\n**Values**: automatically generated "
format: int32
type: integer
UpdatedById:
description: "The ID of the last user to update the object.\n\n**Character\
\ limit**: 32\n\n\n**Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the object was last updated.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
required:
- RatePlanChargeId
type: object
RatePlanData:
properties:
RatePlan:
$ref: '#/definitions/RatePlanDataRatePlan'
RatePlanChargeData:
description: ''
items:
$ref: '#/definitions/RatePlanChargeData'
type: array
SubscriptionProductFeatureList:
description: ''
properties:
SubscriptionProductFeature:
description: ''
items:
$ref: '#/definitions/SubscriptionProductFeature'
type: array
type: object
required:
- RatePlan
type: object
RatePlanDataRatePlan:
allOf:
- properties:
AmendmentId:
description: " The ID of the amendment associated with the rate plan. This\
\ field only applies to amendment rate plans.\n\n\n**Character limit**:\
\ 32\n\n\n**Values**: a valid amendment ID "
type: string
AmendmentSubscriptionRatePlanId:
description: "The ID of the subscription rate plan modified by the amendment.\
\ This field only applies to amendment rate plans.\n\n**Character limit**:\
\ 32\n\n\n**Values**: a valid rate plan ID "
type: string
AmendmentType:
description: "The type of amendment associated with the rate plan. This\
\ field only applies to amendment rate plans.\n\n**Character limit**:\
\ 18\n\n\n**Values**: inherited from `Amendment.Type` "
type: string
CreatedById:
description: "The ID of the Zuora user who created the RatePlan object.\n\
\n**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
CreatedDate:
description: "The date when the `RatePlan` object was last updated.\n\n\
**Character limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
ExternallyManagedPlanId:
description: 'The unique identifier for the rate plan purchased on a third-party
store. This field is used to represent a subscription rate plan created
through third-party stores.
'
type: string
Name:
description: "The name of the rate plan. Leave this null in a subscribe\n\
call to inherited the `ProductRatePlan.Name` field value.\n\n**Character\
\ limit**: 100\n\n\n**Values**: a string of 100 characters or fewer or\
\ inherited from ProductRatePlan.Name "
type: string
ProductRatePlanId:
description: "The ID of the associated product rate plan.\n\n**Character\
\ limit**: 32\n\n\n**Values**: a valid product rate plan ID "
type: string
SubscriptionId:
description: "The ID of the subscription that the rate plan belongs to.\n\
\n**Character limit**: 32\n\n\n**Values**: a valid subscription ID "
type: string
UpdatedById:
description: " The ID of the user who last updated the rate plan.\n\n\n\
**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the rate plan was last updated.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
required:
- ProductRatePlanId
type: object
- $ref: '#/definitions/RatePlanObjectCustomFields'
description: ''
title: RatePlan
RatePlanFeatureOverride:
description: 'Information about feature in rate plan.
'
properties:
customFields:
$ref: '#/definitions/RatePlanFeatureOverrideCustomFields'
description:
description: A description of the feature.
maxLength: 500
type: string
featureId:
description: 'Internal identifier of the feature in the product catalog.
'
type: string
id:
description: 'Internal identifier of the rate plan feature override.
'
type: string
title: ratePlanFeature
type: object
RatePlanFeatureOverrideCustomFields:
additionalProperties:
description: 'Custom fields of the feature. 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: 'A container for custom fields of the feature.
'
title: ratePlanFeatureCustom
type: object
RatePlanObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Rate Plan 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 a Rate Plan object.
'
title: ratePlanFieldsCustom
type: object
RatePlanOverrideForEvergreen:
description: 'Rate plan associated with a subscription.
'
properties:
chargeOverrides:
description: 'List of charges associated with the rate plan.
'
items:
$ref: '#/definitions/ChargeOverrideForEvergreen'
type: array
customFields:
$ref: '#/definitions/RatePlanObjectCustomFields'
newRatePlanId:
description: 'Internal identifier of the rate plan.
'
type: string
productRatePlanId:
description: 'Internal identifier of the product rate plan that the rate plan
is based on.
'
type: string
uniqueToken:
description: |
Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.
For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
maxLength: 50
type: string
required:
- productRatePlanId
title: ratePlan
type: object
RatePlanUpdateForEvergreen:
description: 'Information about an order action of type `UpdateProduct`.
'
properties:
chargeUpdates:
items:
$ref: '#/definitions/ChargeUpdateForEvergreen'
type: array
customFields:
$ref: '#/definitions/RatePlanObjectCustomFields'
newRatePlanId:
description: 'Internal identifier of the updated rate plan in the new subscription
version.
'
type: string
ratePlanId:
description: 'Internal identifier of the rate plan that was updated.
'
type: string
specificUpdateDate:
description: |2
The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.
See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.
format: date
type: string
uniqueToken:
description: 'A unique string to represent the rate plan in the order. The
unique token is used to perform multiple actions against a newly added rate
plan. For example, if you want to add and update a product in the same order,
assign a unique token to the newly added rate plan and use that token in
future order actions.
'
type: string
title: updateProduct
type: object
RecurringFlatFeePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
description: 'Price of the charge in each recurring period.
'
type: number
listPriceBase:
description: |
Specifies the duration of each recurring period.
enum:
- Per_Billing_Period
- Per_Month
- Per_Week
- Per_Year
- Per_Specific_Months
type: string
specificListPriceBase:
description: |
The number of months for the list price base of the charge.
This field is required if you set the value of the `listPriceBase` field
to `Per_Specific_Months`.
**Note**:
- This field is available only if you have the Annual List Price feature enabled.
- The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.
format: int32
maximum: 200
minimum: 1
type: integer
type: object
description: 'Pricing information about a recurring charge that uses the "flat
fee" charge model. In this charge model, the charge has a fixed price.
'
title: recurringFlatFee
RecurringFlatFeePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
type: number
type: object
RecurringPerUnitPricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
description: 'Per-unit price of the charge in each recurring period.
'
type: number
listPriceBase:
description: |
Specifies the duration of each recurring period.
enum:
- Per_Billing_Period
- Per_Month
- Per_Week
- Per_Year
- Per_Specific_Months
type: string
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
specificListPriceBase:
description: 'The number of months for the list price base of the charge.
This field is required if you set the value of the `listPriceBase` field
to `Per_Specific_Months`.
**Note**:
- This field is available only if you have the Annual List Price feature enabled.
- The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.
'
format: int32
maximum: 200
minimum: 1
type: integer
type: object
description: 'Pricing information about a recurring charge that uses the "per
unit" charge model. In this charge model, the charge has a fixed price per unit
purchased.
'
title: recurringPerUnit
RecurringPerUnitPricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
type: number
quantity:
minimum: 0
type: number
type: object
RecurringTieredPricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPriceBase:
description: |
Specifies the duration of each recurring period.
enum:
- Per_Billing_Period
- Per_Month
- Per_Week
- Per_Year
- Per_Specific_Months
type: string
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
specificListPriceBase:
description: 'The number of months for the list price base of the charge.
This field is required if you set the value of the `listPriceBase` field
to `Per_Specific_Months`.
**Note**:
- This field is available only if you have the Annual List Price feature enabled.
- The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.
'
format: int32
maximum: 200
minimum: 1
type: integer
tiers:
description: 'List of cumulative pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
description: 'Pricing information about a recurring charge that uses the "tiered
pricing" charge model. In this charge model, the charge has cumulative pricing
tiers that become effective as units are purchased.
'
title: recurringTiered
RecurringTieredPricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
quantity:
minimum: 0
type: number
tiers:
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
RecurringVolumePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPriceBase:
description: |
Specifies the duration of each recurring period.
enum:
- Per_Billing_Period
- Per_Month
- Per_Week
- Per_Year
- Per_Specific_Months
type: string
quantity:
description: 'Number of units purchased.
'
minimum: 0
type: number
specificListPriceBase:
description: 'The number of months for the list price base of the charge.
This field is required if you set the value of the `listPriceBase` field
to `Per_Specific_Months`.
**Note**:
- This field is available only if you have the Annual List Price feature enabled.
- The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.
'
format: int32
maximum: 200
minimum: 1
type: integer
tiers:
description: 'List of variable pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
description: 'Pricing information about a recurring charge that uses the "volume
pricing" charge model. In this charge model, the charge has a variable price
per unit, depending on how many units are purchased.
'
title: recurringVolume
RecurringVolumePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
quantity:
minimum: 0
type: number
tiers:
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
RefundInvoicePayment:
properties:
InvoiceId:
description: 'The ID of the invoice that the payment is applied to.
'
type: string
RefundAmount:
description: 'The amount of the payment that is refunded. The value of this
field is `0` if no refund is made against the payment.
'
format: decimal
type: string
required:
- InvoiceId
- RefundAmount
type: object
RefundObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Refund 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 a Refund object.
'
title: refundFieldsCustom
type: object
RefundObjectNSFields:
description: 'Container for Refund fields provided by the [Zuora Connector for
NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
properties:
IntegrationId__NS:
description: 'ID of the corresponding object in NetSuite. Only available if
you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
IntegrationStatus__NS:
description: 'Status of the refund''s synchronization with NetSuite. Only
available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
Origin__NS:
description: 'Origin of the corresponding object in NetSuite. Only available
if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
SyncDate__NS:
description: 'Date when the refund was synchronized with NetSuite. Only available
if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
SynctoNetSuite__NS:
description: 'Specifies whether the refund should be synchronized with NetSuite.
Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
title: refundFieldsNS
type: object
RemoveProduct:
description: 'Information about an order action of type `RemoveProduct`.
'
properties:
externalCatalogPlanId:
description: |
An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.
**Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
type: string
ratePlanId:
description: 'ID of the rate plan to remove. This can be the latest version
or any history version of ID.
'
type: string
uniqueToken:
description: Unique identifier for the rate plan. This identifier enables
you to refer to the rate plan before the rate plan has an internal identifier
in Zuora.
type: string
title: removeProduct
type: object
RenewSubscription:
description: 'Information about an order action of type `RenewSubscription`.
'
properties:
billToContactId:
description: |
The ID of the bill-to contact associated with the subscription.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
clearingExistingBillToContact:
default: false
description: |
Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `paymentTerm` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingInvoiceTemplate:
default: false
description: |
Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingPaymentTerm:
default: false
description: |
Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `billToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingSequenceSet:
default: false
description: |
Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
invoiceTemplateId:
description: |
The ID of the invoice template associated with the subscription.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
paymentTerm:
description: |
The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
sequenceSetId:
description: |
The ID of the sequence set associated with the subscription.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
title: RenewSubscription
type: object
RenewalTerm:
properties:
period:
description: 'Duration of the renewal term in months, years, days, or weeks,
depending on the value of the `periodType` field.
'
type: integer
periodType:
description: 'Unit of time that the renewal term is measured in.
'
enum:
- Month
- Year
- Day
- Week
type: string
type: object
RevenueEventItemObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Revenue Event Item 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 a Revenue Event Item object.
'
title: revenueEventItemFieldsCustom
type: object
RevenueEventObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Revenue Event 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 a Revenue Event object.
'
title: revenueEventFieldsCustom
type: object
RevenueScheduleItemObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Revenue Schedule Item 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 a Revenue Schedule Item object.
'
title: revenueScheduleItemFieldsCustom
type: object
RevenueScheduleItemType:
allOf:
- properties:
accountingPeriodName:
description: 'Name of the accounting period. The open-ended accounting period
is named `Open-Ended`.
'
type: string
required:
- accountingPeriodName
type: object
- $ref: '#/definitions/RevenueScheduleItemObjectCustomFields'
title: revenueItems
RevenueScheduleObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Revenue Schedule 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 a Revenue Schedule object.
'
title: revenueScheduleFieldsCustom
type: object
SaveResult:
properties:
Errors:
description: ''
items:
$ref: '#/definitions/ActionsErrorResponse'
type: array
Id:
description: ''
type: string
Success:
description: ''
type: boolean
type: object
SoldToContact:
allOf:
- description: 'Contact details associated with an account.
'
properties:
address1:
description: 'First line of the contact''s address. This is often a street
address or a business name.
'
maxLength: 255
type: string
address2:
description: 'Second line of the contact''s address.
'
maxLength: 255
type: string
city:
description: 'City of the contact''s address.
'
maxLength: 40
type: string
country:
description: 'Country; must be a valid country name or abbreviation. If
using Zuora Tax, you must specify a country in the sold-to contact to
calculate tax. A bill-to contact may be used if no sold-to contact is
provided.
'
maxLength: 64
type: string
county:
description: 'County of the contact''s address.
'
maxLength: 32
type: string
fax:
description: 'Fax number of the contact.
'
maxLength: 40
type: string
firstName:
description: 'First name of the contact.
'
maxLength: 100
type: string
homePhone:
description: 'Home phone number of the contact.
'
maxLength: 40
type: string
lastName:
description: 'Last name of the contact.
'
maxLength: 100
type: string
mobilePhone:
description: 'Mobile phone number of the contact.
'
maxLength: 40
type: string
nickname:
description: 'Nickname of the contact.
'
maxLength: 100
type: string
otherPhone:
description: 'Additional phone number of the contact. Use the `otherPhoneType`
field to specify the type of phone number.
'
maxLength: 40
type: string
otherPhoneType:
description: 'Specifies the type of phone number in the `otherPhone` field.
'
enum:
- Work
- Mobile
- Home
- Other
type: string
personalEmail:
description: 'Personal email address of the contact.
'
format: email
maxLength: 80
type: string
postalCode:
description: 'ZIP code or other postal code of the contact''s address.
'
maxLength: 20
type: string
state:
description: 'State or province of the contact''s address.
'
maxLength: 40
type: string
taxRegion:
description: 'Region defined in your taxation rules. Only applicable if
you use Zuora Tax.
'
maxLength: 32
type: string
workEmail:
description: 'Business email address of the contact.
'
format: email
maxLength: 80
type: string
workPhone:
description: 'Business phone number of the contact.
'
maxLength: 40
type: string
required:
- firstName
- lastName
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
SubscribeRequest:
properties:
Account:
$ref: '#/definitions/SubscribeRequestAccount'
BillToContact:
$ref: '#/definitions/SubscribeRequestBillToContact'
PaymentMethod:
description: |2-
This is the object defining the payment details for the Account. The Account will be updated with this payment as the default payment method.
Use this field to create an electronic payment method for the account. A payment gateway must be enabled.
Values: A valid electronic PaymentMethod.
properties:
AccountId:
description: ' The ID of the customer account associated with this payment
method. '
type: string
AchAbaCode:
description: " The nine-digit routing number or ABA number used by banks.\n\
This field is only required if the `Type` field is set to `ACH`.\n\n\
\n**Character limit**: 9\n\n\n**Values**: a string of 9 characters or\
\ fewer "
type: string
AchAccountName:
description: " The name of the account holder, which can be either a person\
\ or a company.\nThis field is only required if the `Type` field is\
\ set to `ACH`.\n\n\n**Character limit**: 70\n\n\n**Values**: a string\
\ of 70 characters or fewer "
type: string
AchAccountNumber:
description: " The bank account number associated with the ACH payment.\n\
This field is only required if the `Type` field is set to `ACH`.\n\n\
\n**Character limit**: 30\n\n\n**Values**: a string of 30 numeric characters\
\ or fewer "
type: string
AchAccountNumberMask:
description: " This is a masked displayable version of the ACH account\
\ number, used for security purposes. For example: `XXXXXXXXX54321`.\
\ Use this field for ACH payment methods.\n\n\n**Character limit**:\
\ 32\n\n\n**Values**: automatically generated "
type: string
AchAccountType:
description: |2
The type of bank account associated with the ACH payment.
This field is only required if the `Type` field is set to `ACH`.
When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably.
**Character limit**: 16
**Values**:
- `BusinessChecking`
- `BusinessSaving`
- `Checking`
- `Saving`
type: string
AchAddress1:
description: " Line 1 for the ACH address. Required on create for the\
\ Vantiv payment gateway. Optional for other gateways.\n**Character\
\ limit:** **Values:** an address "
type: string
AchAddress2:
description: " Line 2 for the ACH address. Required on create for the\
\ Vantiv payment gateway. Optional for other gateways.\n**Character\
\ limit:** **Values:** an address "
type: string
AchBankName:
description: " The name of the bank where the ACH payment account is held.\
\ Use this field for ACH payment methods.\nWhen creating an ACH payment\
\ method on Adyen, this field is required by Zuora but it is not required\
\ by Adyen. To create the ACH payment method successfully, specify a\
\ real value for this field if you can. If it is not possible to get\
\ the real value for it, specify a dummy value.\n\n\n**Character limit**:\
\ 70\n\n\n**Values**: a string of 70 characters or fewer "
type: string
Active:
description: " Specifies whether a payment method is available in Zuora.\
\ The default value is `false`.\n\n\n**Character limit**: 5\n\n\n**Values**:\
\ `true`, `false` "
type: boolean
BankBranchCode:
description: " The branch code of the bank used for direct debit. Use\
\ this field for direct debit payment methods.\n\n\n**Character limit**:\
\ 10\n\n\n**Values**: string of 10 characters or fewer "
type: string
BankCheckDigit:
description: "The check digit in the international bank account number,\
\ which confirms the validity of the account. Use this field for direct\
\ debit payment methods.\n\n**Character limit**: 4\n\n\n**Values**:\
\ string of 4 characters or fewer "
type: string
BankCity:
description: " The city of the direct debit bank. Use this field for direct\
\ debit payment methods.\n\n\n**Character limit**:70\n\n\n**Values**:\
\ string of 70 characters or fewer "
type: string
BankCode:
description: " The sort code or number that identifies the bank. This\
\ is also known as the sort code. This field is required for direct\
\ debit payment methods.\n\n\n**Character limit**: 18\n\n\n**Values**:\
\ string of 18 characters or fewer "
type: string
BankIdentificationNumber:
description: " The first six or eight digits of the payment method's number,\
\ such as the credit card number or account number. Banks use this number\
\ to identify a payment method.\n\n\n**Character limit**: 8\n\n\n**Values**:\
\ string of 8 characters or fewer "
type: string
BankName:
description: " The name of the direct debit bank. Use this field for direct\
\ debit payment methods.\n\n\n**Character limit**:80\n\n\n**Values**:\
\ string of 80 characters or fewer "
type: string
BankPostalCode:
description: " The zip code or postal code of the direct debit bank. Use\
\ this field for direct debit payment methods.\n\n\n**Character limit**:20\n\
\n\n**Values**: string of 20 characters or fewer "
type: string
BankStreetName:
description: " The name of the street of the direct debit bank. Use this\
\ field for direct debit payment methods.\n\n\n**Character limit**:60\n\
\n\n**Values**: string of 60 characters or fewer "
type: string
BankStreetNumber:
description: " The number of the direct debit bank. Use this field for\
\ direct debit payment methods.\n\n\n**Character limit**:10\n\n\n**Values**:\
\ string of 10 characters or fewer "
type: string
BankTransferAccountName:
description: " The name on the direct debit bank account. Use this field\
\ for direct debit payment methods.\n\n\n**Character limit**: 60\n\n\
\n**Values**: string of 60 characters or fewer "
type: string
BankTransferAccountNumber:
description: " The number of the customer's bank account.\nThis field\
\ is only required if the `Type` field is set to `BankTransfer`.\n\n\
\n**Character limit**:30\n\n\n**Values**: string of 30 characters or\
\ fewer "
type: string
BankTransferAccountNumberMask:
description: " This is a masked displayable version of the ACH account\
\ number, used for security purposes. For example: `XXXXXXXXX54321`.\n\
\n\n**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
BankTransferAccountType:
description: " The type of the customer's bank account. Use this field\
\ for direct debit payment methods.\n\n\n**Character limit**: 11\n\n\
\n**Values**: `DirectDebit` "
type: string
BankTransferType:
description: |2
Specifies the type of direct debit transfer. The value of this field is dependent on the country of the user.
This field is only required if the `Type` field is set to `BankTransfer`.
**Character limit**: 20
**Values**:
- `AutomatischIncasso` (NL)
- `LastschriftDE` (Germany)
- `LastschriftAT` (Austria)
- `DemandeDePrelevement` (FR)
- `DirectDebitUK` (UK)
- `Domicil` (Belgium)
- `LastschriftCH` (CH)
- `RID` (Italy)
- `OrdenDeDomiciliacion` (Spain)
type: string
BusinessIdentificationCode:
description: " The business identification code for Swiss direct payment\
\ methods that use the Global Collect payment gateway. Use this field\
\ only for direct debit payments in Switzerland with Global Collect.\n\
\n\n**Character limit**: 11\n\n\n**Values**: string of 11 characters\
\ or fewer "
type: string
City:
description: " The city of the customer's address. Use this field for\
\ direct debit payment methods.\nIt 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.\n\n\n**Character limit**:80\n\n\
\n**Values**: string of 80 characters or fewer "
type: string
Country:
description: " The two-letter country code of the customer's address.\n\
This field is only required if the `Type` field is set to `BankTransfer`,\
\ and the `BankTransferType` field is set to either `DirectDebitUK`,\
\ `DirectEntryAU`, or `DirectDebitNZ`.\nIt 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.\n\n\n**Character limit**:\
\ 2\n\n\n**Values**: a valid country code "
type: string
CreatedById:
description: " The user ID of the person who created the `PaymentMethod`\
\ object when there is a login user in the user session. In Hosted Payment\
\ Method and Z-Checkout pages, this field is set to 3 as there is no\
\ login user to initiate a user session.\n\n\n**Character limit**: 32\n\
\n\n**Values**: automatically generated "
type: string
CreatedDate:
description: " The date when the `PaymentMethod` object was created in\
\ the Zuora system.\n\n\n**Character limit**: 29\n\n\n**Values**: automatically\
\ generated "
format: date-time
type: string
CreditCardAddress1:
description: " The first line of the card holder's address, which is often\
\ a street address or business name. Use this field for credit card\
\ and direct debit payment methods.\n\n\n**Character limit**: 255\n\n\
\n**Values**: a string of 255 characters or fewer "
type: string
CreditCardAddress2:
description: " The second line of the card holder's address. Use this\
\ field for credit card and direct debit payment methods.\n\n\n**Character\
\ limit**: 255\n\n\n**Values**: a string of 255 characters or fewer "
type: string
CreditCardCity:
description: " The city of the card holder's address. Use this field for\
\ credit card and direct debit payment methods.\nIt 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.\n\n**Character limit**:\
\ 40\n\n\n**Values**: a string of 40 characters or fewer "
type: string
CreditCardCountry:
description: " The country of the card holder's address.\nIt is recommended\
\ to provide the city and country information when creating a payment\
\ method. The information will be used to process payments. If the information\
\ is not provided during payment method creation, the city and country\
\ data will be missing during payment processing. "
type: string
CreditCardExpirationMonth:
description: " The expiration month of the credit card or debit card.\n\
This field is only required if the `Type` field is set to `CreditCard`\
\ or `DebitCard`.\n\n**Character limit**: 2\n\n\n**Values**: a two-digit\
\ number, 01 - 12 "
format: int32
type: integer
CreditCardExpirationYear:
description: " The expiration month of the credit card or debit card.\n\
This field is only required if the `Type` field is set to `CreditCard`\
\ or `DebitCard`.\n\n\n**Character limit**: 4\n\n\n**Values**: a four-digit\
\ number "
format: int32
type: integer
CreditCardHolderName:
description: " The full name of the card holder.\nThis field is only required\
\ if the `Type` field is set to `CreditCard` or `DebitCard`.\n\n\n**Character\
\ limit**: 50\n\n\n**Values**: a string of 50 characters or fewer "
type: string
CreditCardMaskNumber:
description: " A masked version of the credit or debit card number.\n\n\
\n**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
CreditCardNumber:
description: " The credit card or debit card number. This is an insert-only\
\ field; it cannot be updated nor queried for security purposes.\nThis\
\ field is only required if the `Type` field is set to `CreditCard`\
\ or `DebitCard`.\n\n\n**Character limit**: 16\n\n\n**Values**: a string\
\ of 16 characters or fewer "
type: string
CreditCardPostalCode:
description: " The billing address's zip code. This field is required\
\ only when you define a debit card or credit card payment.\n\n\n**Character\
\ limit**: 20\n\n\n**Values**: a string of 20 characters or fewer "
type: string
CreditCardSecurityCode:
description: " The CVV or CVV2 security code. See [How do I control what\
\ information Zuora sends over to the Payment Gateway?](https://knowledgecenter.zuora.com/kb/How_do_I_control_information_sent_to_payment_gateways_when_verifying_payment_methods%3F)\
\ for more information. To ensure PCI compliance, this value is not\
\ stored and cannot be queried.\n\n\n**Character limit**:\n\n\n**Values**:\
\ a valid CVV or CVV2 security code "
type: string
CreditCardState:
description: ' The billing address''s state. Use this field is if the
`CreditCardCountry` value is either Canada or the US. State names must
be spelled in full. '
type: string
CreditCardType:
description: |
The type of the credit card.
Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).
type: string
DeviceSessionId:
description: " The session ID of the user when the `PaymentMethod` was\
\ created or updated. Some gateways use this field for fraud prevention.\
\ If this field is passed to Zuora, then Zuora passes this field to\
\ supported gateways. Currently only Verifi supports this field.\n\n\
\n**Character limit**: 255\n\n\n**Values**: "
type: string
Email:
description: " An email address for the payment method in addition to\
\ the bill to contact email address.\n\n\n**Character limit**: 80\n\n\
\n**Values**: a string of 80 characters or fewer "
type: string
ExistingMandate:
description: " Indicates if the customer has an existing mandate or a\
\ new mandate. A mandate is a signed authorization for UK and NL customers.\
\ When you are migrating mandates from another system, be sure to set\
\ this field correctly. If you indicate that a new mandate is an existing\
\ mandate or vice-versa, then transactions fail. This field is used\
\ only for the direct debit payment method.\n\n\n**Character limit**:\
\ 3\n\n\n**Values**: `Yes`, `No` "
type: string
FirstName:
description: " The customer's first name. This field is used only for\
\ the direct debit payment method.\n\n\n**Character limit**: 30\n\n\n\
**Values**: a string of 30 characters or fewer "
type: string
GatewayOptionData:
description: " Use this field to pass gateway options. Zuora sends all\
\ the information that you specified to the gateway. If you specify\
\ any unsupported gateway option parameters, they will be ignored without\
\ error prompts.\n\n\n**Character limit**: 255\n\n\n**Values**: GatewayOption "
properties:
GatewayOption:
description: ''
items:
$ref: '#/definitions/GatewayOption'
type: array
required:
- GatewayOption
type: object
IBAN:
description: " The International Bank Account Number. This field is used\
\ only for the direct debit payment method.\n\n\n**Character limit**:\
\ 42\n\n\n**Values**: a string of 42 characters or fewer "
type: string
IPAddress:
description: ' The IPv4 or IPv6 information of the user when the payment
method was created or updated. Gateways use this field for fraud prevention.
If this field is passed to Zuora, then Zuora passes this field to supported
gateways. If the IP address length is beyond 45 characters, a validation
error occurs. '
type: string
Id:
description: " The ID of this object. Upon creation, the ID of this object\
\ is `PaymentMethodId`.\n\n\n**Character limit**: 32\n\n\n**Values**:\
\ automatically generated "
type: string
LastFailedSaleTransactionDate:
description: " The date of the last failed attempt to collect payment\
\ with this payment method.\n\n\n**Character limit**: 29\n\n\n**Values**:\
\ automatically generated "
format: date-time
type: string
LastName:
description: " The customer's last name. This field is used only for the\
\ direct debit payment method.\n\n\n**Character limit**: 70\n\n\n**Values**:\
\ a string of 70 characters or fewer "
type: string
LastTransactionDateTime:
description: " The date of the most recent transaction.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: a valid date and time value "
format: date-time
type: string
LastTransactionStatus:
description: " The status of the most recent transaction.\n\n\n**Character\
\ limit**: 39\n\n\n**Values**: automatically generated "
type: string
MandateCreationDate:
description: |2+
The date when the mandate was created, in `yyyy-mm-dd` format. A mandate is a signed authorization for UK and NL customers. This field is used only for the direct debit payment method.
**Character limit**: 29
format: date
type: string
MandateID:
description: " The ID of the mandate. A mandate is a signed authorization\
\ for UK and NL customers. This field is used only for the direct debit\
\ payment method.\n\n\n**Character limit**: 36\n\n\n**Values**: a string\
\ of 36 characters or fewer "
type: string
MandateReceived:
description: " Indicates if the mandate was received. A mandate is a\
\ signed authorization for UK and NL customers. This field is used only\
\ for the direct debit payment method.\n\n\n**Character limit**: 3\n\
\n\n**Values**: `Yes`, `No `(case-sensitive) "
type: string
MandateUpdateDate:
description: |2+
The date when the mandate was last updated, in `yyyy-mm-dd` format. A mandate is a signed authorization for UK and NL customers. This field is used only for the direct debit payment method.
**Character limit**: 29
format: date
type: string
MaxConsecutivePaymentFailures:
description: " Specifies the number of allowable consecutive failures\
\ Zuora attempts with the payment method before stopping.\nWhen the\
\ `UseDefaultRetryRule` field is set to `false`, this field is only\
\ required if the `PaymentRetryWindow` field is not defined.\n\n\n\n\
**Values**: a valid number "
type: integer
MitConsentAgreementRef:
description: 'Specifies your reference for the stored credential consent agreement
that you have established with the customer. Only applicable if you set
the `MitProfileAction` field.
'
maxLength: 128
type: string
MitConsentAgreementSrc:
description: 'Required if you set the `MitProfileAction` field. If you do not specify the `MitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.
'
enum:
- External
type: string
MitNetworkTransactionId:
description: 'Specifies the ID of a network transaction. Only applicable if
you set the `MitProfileAction` field to `Persist`.
'
maxLength: 128
type: string
MitProfileAction:
enum:
- Activate
- Persist
type: string
description: 'Specifies how Zuora creates and activates a stored credential profile. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.'
MitProfileAgreedOn:
description: 'The date on which the profile is agreed. The date format is
`yyyy-mm-dd`.
'
format: date
type: string
MitProfileType:
description: 'Required if you set the `MitProfileAction` field. If you do not specify the `MitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.
'
enum:
- Recurring
type: string
Name:
description: ' Create Query Delete Filter '
type: string
NumConsecutiveFailures:
description: " The number of consecutive failed payment for this payment\
\ method. It is reset to 0 upon successful payment. You can use the\
\ API to update the field value to 0.\n\n\n**Character limit**:\n\n\n\
**Values**: a positive whole number "
format: int32
type: integer
PaymentMethodStatus:
description: " Specifies the status of the payment method. It is set to\
\ Active on creation.\n\n\n**Character limit**: 6\n\n\n**Values**: `Active`\
\ or `Closed` PaymentMethodStatus should not be used in the `create\n\
` call. You can only set this field to **Closed** via the `update\n\
` call. "
type: string
PaymentRetryWindow:
description: " The retry interval setting, which prevents making a payment\
\ attempt if the last failed attempt was within the last specified number\
\ of hours.\nWhen the `UseDefaultRetryRule` field is set to `false`,\
\ this field is only required if the `MaxConsecutivePaymentFailures`\
\ field is not defined.\n\n\n**Character limit**: 4\n\n\n**Values**:\
\ a whole number between 1 and 1000, exclusive "
type: integer
PaypalBaid:
description: " The PayPal billing agreement ID, which is a contract between\
\ two PayPal accounts. Typically, the selling party initiates a request\
\ to create a BAID, and sends it to buying party for acceptance. The\
\ seller can keep track of the BAID and use it for future charges against\
\ the buyer.\nThis field is only required if the `Type` field is set\
\ to `PayPal`.\n\n\n**Character limit**: 64\n\n\n**Values**: a string\
\ of 64 characters or fewer "
type: string
PaypalEmail:
description: " The email address associated with the account holder's\
\ PayPal account or of the PayPal account of the person paying for the\
\ service.\nThis field is only required if the `Type` field is set to\
\ `PayPal`.\n\n\n**Character limit**: 80\n\n\n**Values**: a string of\
\ 80 characters or fewer "
type: string
PaypalPreapprovalKey:
description: " PayPal's Adaptive Payments API key. Zuora does not create\
\ this key, nor does it call PayPal to generate it. You must use PayPal's\
\ Adaptive Payments' API to generate this key, and then pass it to Zuora.\
\ Zuora uses this key to authorize future payments to PayPal's Adaptive\
\ Payments API.\nThis field is only required if you use PayPal Adaptive\
\ Payments gateway.\n\n\n**Character limit**: 32\n\n\n**Values**: a\
\ valid PayPal Adaptive Payment pre-approval key "
type: string
PaypalType:
description: " Specifies the PayPal gateway: PayFlow Pro, Express Checkout,\
\ or Adaptive Payments.\nThis field is only required if you use the\
\ PayPal Adaptive Payments, Payflow Pro, or Express Checkout gateway.\n\
\n\n**Character limit**: 32\n\n\n**Values**: `ExpressCheckout`, `NativeExpressCheckout`,\
\ `AdaptivePayments` "
type: string
Phone:
description: " The phone number that the account holder registered with\
\ the bank. This field is used for credit card validation when passing\
\ to a gateway.\n\n\n**Character limit**: 40\n\n\n**Values**: a string\
\ of 40 characters or fewer "
type: string
PostalCode:
description: " The zip code of the customer's address. This field is used\
\ only for the direct debit payment method.\n\n\n**Character limit**:\
\ 20\n\n\n**Values**: a string of 20 characters or fewer "
type: string
SecondTokenId:
description: " A gateway unique identifier that replaces sensitive payment\
\ method data. SecondTokenId is conditionally required only when TokenID\
\ is being used to represent a gateway customer profile. SecondTokenId\
\ is used in the CC Reference Transaction payment method.\n\n**Character\
\ limit**: 64\n\n\n**Values**: a string of 64 characters or fewer "
type: string
SkipValidation:
description: " Creates the payment method even if authorization fails\
\ with the payment gateway.\n\n\n**Character limit**: 5\n\n\n**Values**:\
\ `t``rue`, `false` "
type: boolean
State:
description: " The state of the customer's address. This field is used\
\ only for the direct debit payment method.\n\n\n**Character limit**:\
\ 70\n\n\n**Values**: a string of 70 characters or fewer "
type: string
StreetName:
description: " The street name of the customer's address. This field is\
\ used only for the direct debit payment method.\n\n\n**Character limit**:\
\ 100\n\n\n**Values**: a string of 100 characters or fewer "
type: string
StreetNumber:
description: " The street number of the customer's address. This field\
\ is used only for the direct debit payment method.\n\n\n**Character\
\ limit**: 30\n\n\n**Values**: a string of 30 characters or fewer "
type: string
TokenId:
description: "A gateway unique identifier that replaces sensitive payment\
\ method data or represents a gateway's unique customer profile. If\
\ you want to create an Amazon Pay payment method, specify `AmazonBillingAgreementId`\
\ for this field. \n\nWhile `TokenId` is used to represent a customer\
\ profile, `SecondTokenId` is conditionally required for representing\
\ the underlying tokenized payment method. When the `Type` field is\
\ set to `CreditCardReferenceTransaction`, this field is required if\
\ the `CreditCardNumber` field is not specified.\n\nThe values for the\
\ `TokenId` and `SecondTokenId` fields differ for gateways. For more\
\ information, see the Knowledge Center article specific to each gateway\
\ that supports the CC Reference Transaction payment method.\n\n**Character\
\ limit**: 255\n**Values**: a string of 255 characters or fewer\n"
type: string
TotalNumberOfErrorPayments:
description: " The number of error payments that used this payment method.\n\
\n\n**Character limit**:\n\n\n**Values**: automatically generated "
format: int32
type: integer
TotalNumberOfProcessedPayments:
description: " The number of successful payments that used this payment\
\ method.\n\n\n**Character limit**:\n\n\n**Values**: automatically generated "
format: int32
type: integer
Type:
description: The type of payment method. If you want to create an Amazon
Pay payment method, specify `CreditCardReferenceTransaction` for this
field.
enum:
- ACH
- BankTransfer
- CreditCard
- CreditCardReferenceTransaction
- DebitCard
- PayPal
type: string
UpdatedById:
description: " The ID of the user who last updated the payment method.\n\
\n\n**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the payment method was last updated.\n\n\n\
**Character limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
UseDefaultRetryRule:
description: " Determines whether to use the default retry rules configured\
\ in the [Z-Payments settings](https://knowledgecenter.zuora.com/CB_Billing/L_Payment_Methods/H_Configure_Payment_Method_Retry_Rules).\
\ Set this to `true` to use the default retry rules. Set this to `false`\
\ to set the specific rules for this payment method. If you set this\
\ value to `false`, then the fields, `PaymentRetryWindow` and `MaxConsecutivePaymentFailures`,\
\ are required.\n\n\n**Character limit**: 5\n\n\n**Values**: `t``rue`,\
\ `false` "
type: boolean
required:
- Type
type: object
PreviewOptions:
description: 'Only used if you want to call this operation in preview mode.
After a call in preview mode is completed, Zuora will roll back the subscription
and return only the temporary invoice data.
'
properties:
EnablePreviewMode:
description: "Specifies whether the call should create a subscription/amendment,\
\ or whether it should return a preview of the order. Used with either\
\ NumberOfPeriods or PreviewThroughTermEnd. \n\nIf the preview mode\
\ is enabled, Zuora recommends that you set the `subscribes` > `SubscribeOptions`\
\ > `ProcessPayments` field to `false` and skip setting the `subscribes`\
\ > `PaymentMethod` field in your request so that no charge occurs for\
\ payment method validation in a preview.\n"
type: boolean
NumberOfPeriods:
description: 'The number of invoice periods to show in a preview.
'
type: integer
PreviewThroughTermEnd:
description: 'Specifies whether to preview the charge through the end
of the subscription term. Applicable to termed subscriptions only.
'
type: boolean
PreviewType:
default: InvoiceItem
description: |
The type of preview to return:
* `InvoiceItem` - Return an invoice item preview
* `ChargeMetrics` - Return a charge metrics preview
* `InvoiceItemChargeMetrics` - Return an invoice item and charge metrics of that item
enum:
- InvoiceItem
- ChargeMetrics
- InvoiceItemChargeMetrics
type: string
type: object
SoldToContact:
$ref: '#/definitions/SubscribeRequestSoldToContact'
SubscribeOptions:
description: " This optional object specifies parameters related to invoicing\
\ - whether to immediately generate an invoice and collect payment, and\
\ whether the invoice should cover all subscriptions or just this new subscription.\n\
The default behavior is to invoice immediately for all the account's subscriptions,\
\ with the current date as the target date, and immediately collect payment\
\ if the account's `AutoPay` flag is true.\n\n\n**Values:** A valid SubscribeOptions\
\ object. "
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:
description: ''
properties:
PaymentMethodId:
description: ID of a credit card payment method.
type: string
type: object
ExternalPaymentOptions:
description: ''
properties:
Amount:
description: ''
format: double
type: number
EffectiveDate:
description: ''
format: date
type: string
GatewayOrderId:
description: ''
type: string
PaymentMethodId:
description: ''
type: string
ReferenceId:
description: ''
maxLength: 100
type: string
type: object
GenerateInvoice:
description: ''
type: boolean
ProcessPayments:
description: "Use this when you are using electronic payment types.\n\n\
If `GenerateInvoice` is true, specifies whether payment should be applied\
\ when the subscription is created. If the `Account` > `AutoPay` flag\
\ is true and `GenerateInvoice` is true and `ProcessPayments` is true,\
\ then the payment is created for the invoice balance and charged. The\
\ default value is `true`. \n\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. You 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 only supports the case that one single subscription is created\
\ by the Subscribe action. Also, the retry mechanism does not support\
\ the preview mode of the Subscribe action.\n"
type: boolean
SubscribeInvoiceProcessingOptions:
description: ''
properties:
InvoiceDate:
description: ''
format: date
type: string
InvoiceProcessingScope:
description: |
A string specifying the scope of the requested invoice. Possible values:
* `Account` invoice for all subscriptions within the account - the default value. If the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature is enabled, invoices for order line items within the account will also be generated.
* `Subscription` invoice for only the subscription being created in this call
type: string
InvoiceTargetDate:
description: ''
format: date
type: string
type: object
required:
- GenerateInvoice
- ProcessPayments
type: object
SubscriptionData:
description: " This object contains the information on the contract's dates\
\ and terms.\n\n\n**Values:** A valid SubscriptionData object. "
properties:
RatePlanData:
description: ''
items:
$ref: '#/definitions/RatePlanData'
type: array
Subscription:
$ref: '#/definitions/SubscribeRequestSubscriptionDataSubscription'
required:
- Subscription
- RatePlanData
type: object
required:
- Account
- SubscriptionData
type: object
SubscribeRequestAccount:
allOf:
- properties:
AccountNumber:
description: |
Unique account number assigned to the account.
**Character limit**: 50
**Values**: one of the following:
- null to auto-generate
- a string of 50 characters or fewer that doesn't begin with the default account number prefix
type: string
AdditionalEmailAddresses:
description: "List of additional email addresses to receive emailed invoices.\n\
\n**Character limit**: 120\n\n\n**Values**: comma-separated list of email\
\ addresses "
type: string
AllowInvoiceEdit:
description: " Indicates if associated invoices can be edited.\n\n\n**Character\
\ limit**: 5\n\n\n**Values**: `true`, `false` (default if left null) "
type: boolean
AutoPay:
description: " Indicates if future payments are automatically collected\
\ when they're due during a Payment Run.\n\n\n**Character limit**: 5\n\
\n\n**Values**: `true`, `false` (default) "
type: boolean
Batch:
description: |
Organizes your customer accounts into groups to optimize\
\ your billing and payment operations.\n\n\n**Character limit**: 20\n\n\
\n**Values**:any system-defined batch (`Batch1` - `Batch50 `or by name).
**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
type: string
BcdSettingOption:
description: "Billing cycle day setting option.\n\n**Character limit**:\
\ 9\n\n\n**Values**: `AutoSet`, `ManualSet` "
type: string
BillCycleDay:
description: "Billing cycle day (BCD) on which bill runs generate invoices\
\ for the account.\n\n**Character limit**: 2\n\n\n**Values**: any activated\
\ system-defined bill cycle day (`1` - `31`) "
format: int32
type: integer
CommunicationProfileId:
description: "Associates the account with a specified communication profile.\n\
\n**Character limit**: 32\n\n\n**Values**: a valid communication profile\
\ ID "
type: string
CrmId:
description: "CRM account ID for the account. A CRM is a customer relationship\
\ management system, such as Salesforce.com.\n\n**Character limit**: 100\n\
\n\n**Values**: a string of 100 characters or fewer "
type: string
Currency:
description: ' Currency that the customer is billed in. See [a currency
value defined in the Zuora Ui admin settings](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Customize_Currencies) '
type: string
CustomerServiceRepName:
description: "Name of the account's customer service representative, if\
\ applicable.\n\n**Character limit**: 50\n\n\n**Values**: a string of\
\ 50 characters or fewer "
type: string
DefaultPaymentMethodId:
description: "ID of the default payment method for the account. This field\
\ is only required if the `AutoPay` field is set to `true`.\n\n**Character limit**: 32\n\
\n\n**Values**: A valid ID for an existing payment method. This field\
\ does not support external payment methods. "
type: string
Id:
description: Internal identifier of an existing account. Only set this field
if you want to assign the subscription to an existing account.
type: string
InvoiceDeliveryPrefsEmail:
description: "Indicates if the customer wants to receive invoices through\
\ email.\n**Character limit**: 5\n\n\n**Values**: `true`, `false` (default\
\ if left null) "
type: boolean
InvoiceDeliveryPrefsPrint:
description: "Indicates if the customer wants to receive printed invoices,\
\ such as through postal mail.\n\n**Character limit**: 5\n\n\n**Values**:\
\ `true`, `false` (default if left null) "
type: boolean
InvoiceTemplateId:
description: |+
The ID of the invoice template. Each customer account can use a specific invoice template for invoice generation.
**Character limit**: 32
**Values**: a[ valid template ID configured in Z-Billing Settings](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Manage_Invoice_Rules_and_Templates) To find the ID of your current invoice template: In Zuora, navigate to **Settings > Z-Billing > Manage Invoice Rules and Templates** and click **Show Id **next to the template you want to use.
type: string
LastInvoiceDate:
description: " The date when the previous invoice was generated for the\
\ account. The field value is null if no invoice has ever been generated\
\ for the account.\n\n\n**Character limit**: 29\n\n\n**Values**: automatically\
\ generated "
format: date
type: string
Name:
description: "Name of the account as displayed in the Zuora UI.\n\n**Character\
\ limit**: 255\n\n\n**Values**: a string of 255 characters or fewer "
type: string
Notes:
description: " Comments about the account.\n\n**Character limit**: 65,535\n\
\n\n**Values**: a string of 65,535 characters "
type: string
ParentId:
description: "Identifier of the parent customer account for this Account\
\ object. Use this field if you have customer hierarchy enabled.\n\n**Character\
\ limit**: 32\n\n\n**Values**: a valid account ID "
type: string
PaymentGateway:
description: |
Gateway used for processing electronic payments and refunds. This field is only required if there is no default payment gateway is defined in the tenant.
**Character limit**: 40
**Values**: one of the following:
- a valid configured gateway name
- Null to inherit the default value set in Z-Payment Settings
type: string
PaymentTerm:
description: "Indicates when the customer pays for subscriptions.\n\n**Character\
\ limit**: 100\n\n\n**Values**: [a valid, active payment term defined\
\ in the web-based UI administrative settings](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Payment_Terms) "
type: string
PurchaseOrderNumber:
description: "The number of the purchase order associated with this account.\
\ Purchase order information generally comes from customers.\n\n**Character\
\ limit**: 100\n\n\n**Values**: a string of 100 characters or fewer "
type: string
SalesRepName:
description: "The name of the sales representative associated with this\
\ account, if applicable.\n\n**Character limit**: 50\n\n\n**Values**:\
\ a string of 50 characters or fewer "
type: string
TaxCompanyCode:
description: " Unique code that identifies a company account in Avalara.\
\ Use this field to calculate taxes based on origin and sold-to addresses\
\ in Avalara.\nThis 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\n\n**Character limit**: 50\n\n\n**Values**: a valid company code "
type: string
TaxExemptCertificateID:
description: "ID of your customer's tax exemption certificate.\n\n**Character\
\ limit**: 32\n\n\n**Values**: a string of 32 characters or fewer "
type: string
TaxExemptCertificateType:
description: "Type of the tax exemption certificate that your customer holds.\n\
**Character limit**: 32\n\n\n**Values**: a string of 32 characters or\
\ fewer "
type: string
TaxExemptDescription:
description: "Description of the tax exemption certificate that your customer\
\ holds.\n\n**Character limit**: 500\n\n\n**Values**: a string of 500\
\ characters or fewer "
type: string
TaxExemptEffectiveDate:
description: "Date when the the customer's tax exemption starts.\n\n**Character\
\ limit**: 29 **Version notes**: requires Z-Tax "
format: date
type: string
TaxExemptExpirationDate:
description: "Date when the customer's tax exemption certificate expires\n\
**Character limit**: 29 **Version notes**: requires Z-Tax "
format: date
type: string
TaxExemptIssuingJurisdiction:
description: "Indicates the jurisdiction in which the customer's tax exemption\
\ certificate was issued.\n\n**Character limit**: 32\n\n\n**Values**:\
\ a string of 32 characters or fewer "
type: string
TaxExemptStatus:
description: |2
Status of the account's tax exemption. This field is only required if you use Zuora Tax. This field is not available if you do not use Zuora Tax.
**Character limit**: 19
**Values**: one of the following:
- `Yes`
- `No`
- `PendingVerification`
type: string
TotalInvoiceBalance:
description: "Total balance of the account's invoices.\n\n**Character limit**:\
\ 16\n\n\n**Values**: a valid currency value "
format: double
type: number
VATId:
description: " EU Value Added Tax ID.\nThis 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\n\n**Character limit**:\
\ 25\n\n\n**Values**: a valid Value Added Tax ID "
type: string
required:
- Batch
- BillCycleDay
- Currency
- Name
type: object
- $ref: '#/definitions/AccountObjectNSFields'
- $ref: '#/definitions/AccountObjectCustomFields'
description: |2-
This is the Account object containing the information for this particular subscription. It has all the information needed to create an account for a subscription.
**Values:** A valid account.
title: Account
SubscribeRequestBillToContact:
allOf:
- properties:
AccountId:
description: " The Zuora account ID associated with this contact. This field\
\ is not required when you use the subscribe\ncall. This field is required\
\ for all other calls.\n**Character limit: **32 **Values: **a valid account\
\ ID "
type: string
Address1:
description: " The first line of the contact's address, which is often a\
\ street address or business name.\n\n\n**Character limit**: 255\n\n\n\
**Values**: a string of 255 characters or fewer "
type: string
Address2:
description: " The second line of the contact's address.\n\n\n**Character\
\ limit**: 255\n\n\n**Values**: a string of 255 characters or fewer "
type: string
City:
description: " The city of the contact's address.\n\n\n**Character limit**:\
\ 40 **Values: **a string of 40 characters or fewer "
type: string
Country:
description: ' The country of the contact''s address. This field is only
required if you enbale taxation. '
type: string
County:
description: " The country. May optionally be used by [Z-Tax](/C_Zuora_User_Guides/A_Billing_and_Payments/I_Taxes/Z-Tax)\
\ to calculate county tax.\n\n\n**Character limit**: 32\n\n\n**Values**:\
\ a string of 32 characters or fewer "
type: string
CreatedById:
description: "The ID of the Zuora user who created the contact.\n\n**Character\
\ limit**: 32\n\n\n**Values**: automatically generated "
type: string
CreatedDate:
description: "The date when the contact was created.\n\n**Character limit**:\
\ 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
Description:
description: " A description for the contact.\n\n\n**Character limit**:\
\ 100\n\n\n**Values**: a string of 100 characters or fewer "
type: string
Fax:
description: " The contact's fax number.\n\n\n**Character limit**: 40\n\n\
\n**Values**: a string of 40 characters or fewer "
type: string
FirstName:
description: " The contact's first name.\n\n\n**Character limit**: 100\n\
\n\n**Values**: a string of the contact's first name "
type: string
HomePhone:
description: " The contact's home phone number.\n\n\n**Character limit**:\
\ 40\n\n\n**Values**: a string of 40 characters or fewer "
type: string
LastName:
description: " The contact's last name.\n\n\n**Character limit**: 100\n\n\
\n**Values**: a string of 100 characters or fewer "
type: string
MobilePhone:
description: " The contact's mobile phone number.\n\n\n**Character limit**:\
\ 40\n\n\n**Values**: a string of 40 characters or fewer "
type: string
NickName:
description: " A nickname for the contact.\n\n\n**Character limit**: 100\n\
\n\n**Values**: a string of 100 characters or fewer "
type: string
OtherPhone:
description: " An additional phone number for the contact.\n\n\n**Character\
\ limit**: 40\n\n\n**Values**: a string of 40 characters or fewer "
type: string
OtherPhoneType:
description: "The type of the `OtherPhone`.\n\n**Character limit**: 20\n\
\n\n**Values**: `Work`, `Mobile`, `Home`, `Other` "
type: string
PersonalEmail:
description: " The contact's personal email address.\n\n\n**Character limit**:\
\ 80\n\n\n**Values**: a string of 80 characters or fewer "
type: string
PostalCode:
description: " The zip code for the contact's address.\n**Character limit:**\
\ 20 **Values: **a string of 20 characters or fewer "
type: string
State:
description: ' The state or province of the contact''s address. '
type: string
TaxRegion:
description: 'If using [Z-Tax](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/L_Taxes/A_Z-Tax)
tax rules '
type: string
UpdatedById:
description: " The ID of the user who lasted updated the contact.\n\n\n\
**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the contact was last updated.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
WorkEmail:
description: " The contact's business email address.\n\n\n**Character limit**:\
\ 80\n\n\n**Values**: a string of 80 characters or fewer "
type: string
WorkPhone:
description: " The contact's business phone number.\n\n\n**Character limit**:\
\ 40 **notes**: --\n\n\n**Values**: a string of 40 characters or fewer "
type: string
required:
- FirstName
- LastName
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
description: |2-
This is the object that contains the contact associated with this account in the Account's `BillToId` field.
This field is only required if the account does not exist.
Values: A valid contact for the account.
title: Contact
SubscribeRequestSoldToContact:
allOf:
- properties:
AccountId:
description: " The Zuora account ID associated with this contact. This field\
\ is not required when you use the subscribe\ncall. This field is required\
\ for all other calls.\n**Character limit: **32 **Values: **a valid account\
\ ID "
type: string
Address1:
description: " The first line of the contact's address, which is often a\
\ street address or business name.\n\n\n**Character limit**: 255\n\n\n\
**Values**: a string of 255 characters or fewer "
type: string
Address2:
description: " The second line of the contact's address.\n\n\n**Character\
\ limit**: 255\n\n\n**Values**: a string of 255 characters or fewer "
type: string
City:
description: " The city of the contact's address.\n\n\n**Character limit**:\
\ 40 **Values: **a string of 40 characters or fewer "
type: string
Country:
description: ' The country of the contact''s address. '
type: string
County:
description: " The country. May optionally be used by [Z-Tax](/C_Zuora_User_Guides/A_Billing_and_Payments/I_Taxes/Z-Tax)\
\ to calculate county tax.\n\n\n**Character limit**: 32\n\n\n**Values**:\
\ a string of 32 characters or fewer "
type: string
CreatedById:
description: "The ID of the Zuora user who created the contact.\n\n**Character\
\ limit**: 32\n\n\n**Values**: automatically generated "
type: string
CreatedDate:
description: "The date when the contact was created.\n\n**Character limit**:\
\ 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
Description:
description: " A description for the contact.\n\n\n**Character limit**:\
\ 100\n\n\n**Values**: a string of 100 characters or fewer "
type: string
Fax:
description: " The contact's fax number.\n\n\n**Character limit**: 40\n\n\
\n**Values**: a string of 40 characters or fewer "
type: string
FirstName:
description: " The contact's first name.\n\n\n**Character limit**: 100\n\
\n\n**Values**: a string of the contact's first name "
type: string
HomePhone:
description: " The contact's home phone number.\n\n\n**Character limit**:\
\ 40\n\n\n**Values**: a string of 40 characters or fewer "
type: string
LastName:
description: " The contact's last name.\n\n\n**Character limit**: 100\n\n\
\n**Values**: a string of 100 characters or fewer "
type: string
MobilePhone:
description: " The contact's mobile phone number.\n\n\n**Character limit**:\
\ 40\n\n\n**Values**: a string of 40 characters or fewer "
type: string
NickName:
description: " A nickname for the contact.\n\n\n**Character limit**: 100\n\
\n\n**Values**: a string of 100 characters or fewer "
type: string
OtherPhone:
description: " An additional phone number for the contact.\n\n\n**Character\
\ limit**: 40\n\n\n**Values**: a string of 40 characters or fewer "
type: string
OtherPhoneType:
description: "The type of the `OtherPhone`.\n\n**Character limit**: 20\n\
\n\n**Values**: `Work`, `Mobile`, `Home`, `Other` "
type: string
PersonalEmail:
description: " The contact's personal email address.\n\n\n**Character limit**:\
\ 80\n\n\n**Values**: a string of 80 characters or fewer "
type: string
PostalCode:
description: " The zip code for the contact's address.\n**Character limit:**\
\ 20 **Values: **a string of 20 characters or fewer "
type: string
State:
description: ' The state or province of the contact''s address. '
type: string
TaxRegion:
description: 'If using [Z-Tax](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/L_Taxes/A_Z-Tax)
tax rules '
type: string
UpdatedById:
description: " The ID of the user who lasted updated the contact.\n\n\n\
**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
UpdatedDate:
description: " The date when the contact was last updated.\n\n\n**Character\
\ limit**: 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
WorkEmail:
description: " The contact's business email address.\n\n\n**Character limit**:\
\ 80\n\n\n**Values**: a string of 80 characters or fewer "
type: string
WorkPhone:
description: " The contact's business phone number.\n\n\n**Character limit**:\
\ 40 **notes**: --\n\n\n**Values**: a string of 40 characters or fewer "
type: string
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
description: " Unless otherwise specified, this field defaults to the information\
\ in the `BillToContact` field.\n\n**Values:** A valid contact. "
title: Contact
SubscribeRequestSubscriptionDataSubscription:
allOf:
- properties:
AccountId:
description: ' This field can be updated when `Status` is `Draft`. '
type: string
AncestorAccountId:
description: " A filter option for querying all subscriptions under the\
\ same account hierarchy.\n\n\n**Character limit**: 32\n\n\n**Values**:\
\ a valid account ID "
type: string
AutoRenew:
description: " This field can be updated when `Status` is `Draft`. Indicates\
\ if the subscription automatically renews at the end of the term. This\
\ field is only required if the `TermType` field is set to `TERMED`.\n\
\n\n\n**Values**: `true`, `false` "
type: boolean
CancelledDate:
description: " The date of the amendment that canceled the subscription.\n\
\n\n\n**Values**: inherited from `Amendment`.`EffectiveDate` "
format: date
type: string
ContractAcceptanceDate:
description: |2
The date when the customer accepts the contract. This field can be updated when **Status** is `Draft`.
This field is only required if the [Require Service Activation of Orders?](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) Setting is set to `Yes`. If this setting is set to `Yes`:
- If ContractAcceptanceDate field is required, you must set this field, ContractAcceptanceDate, and ContractEffectiveDate fields in the subscribe call to activate a subscription.
- If ContractAcceptanceDate field is not required, you must set both this field and the ContractEffectiveDate field in the subscribe call to activate a subscription. If you only set a valid date in the ContractEffectiveDate field, the subscribe call still returns success, but the subscription is in `DRAT` status.
format: date
type: string
ContractEffectiveDate:
description: " The date when the contract takes effect. This field can be\
\ updated when **Status** is `Draft`.\n\n\n**Note**: This field is required\
\ in the subscribe call. If you set the value of this field to null and\
\ both the ServiceActivationDate and ContractAcceptanceDate fields are\
\ not required, the subscribe call still returns success, but the new\
\ subscription is in `DRAFT` status. To activate the subscription, you\
\ must set a valid date to this field. "
format: date
type: string
CreatedById:
description: "The user ID of the person who created the subscription.\n\n\
**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
CreatedDate:
description: " The date the subscription was created. This value is the\
\ same as the OriginalCreatedDate value until the subscription is amended.\n\
\n\n\n**Values**: automatically generated "
format: date-time
type: string
CreatorAccountId:
description: " The account ID that created the subscription or the amended\
\ subscription.\n\n\n**Character limit**: 32\n\n\n**Values**: automatically\
\ generated "
type: string
CreatorInvoiceOwnerId:
description: "The account ID that owns the invoices associated with the\
\ subscription or the amended subscription.\n\n\n**Character limit**:\
\ 32\n\n\n**Values**: automatically generated "
type: string
CurrentTerm:
description: " The length of the period for the current subscription term.\
\ This field is only required If the `TermType` field is set to `TERMED`\
\ and its value must be greater than `0`. If TermType is set to `EVERGREEN`,\
\ this value is ignored. Default is `0`.\n\n\n**Character limit**: 20\n\
\n\n**Values**: automatically generated "
format: int32
type: integer
CurrentTermPeriodType:
description: |2
The period type for the current subscription term. This field is used with the CurrentTerm field to specify the current subscription term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
type: string
ExternallyManagedBy:
description: 'An enum field on the Subscription object to indicate the name
of a third-party store. This field is used to represent subscriptions
created through third-party stores.
'
enum:
- Amazon
- Apple
- Google
- Roku
type: string
InitialTerm:
description: " The length of the period for the first subscription term.\
\ This field can be updated when Status is `Draft`. If you use the subscribe\n\
call, this field is required.\n\n\nThis field is only required if the\
\ `TermType` field is set to `TERMED`.\n\n**Character limit**: 20\n\n\n\
**Values**: any valid number. The default value is 0. "
format: int32
type: integer
InitialTermPeriodType:
description: |2
The period type for the first subscription term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
**Note**:
- This field can be updated when `Status` is `Draft`.
- This field is used with the `InitialTerm` field to specify the initial subscription term.
type: string
InvoiceOwnerId:
description: ' This field can be updated when `Status` is `Draft`. '
type: string
IsInvoiceSeparate:
description: " Determines if the subscription is invoiced separately. If\
\ `TRUE`, then all charges for this subscription are collected into the\
\ subscription's own invoice.\n\n\n\n**Values**: `TRUE`, `FALSE `(default) "
type: boolean
LastBookingDate:
description: "The last booking date of the subscription object. This field\
\ is writable only when the subscription is newly created as a first version\
\ subscription. You can override the date value when creating a subscription\
\ through the Subscribe and Amend API or the subscription creation UI\
\ (non-Orders). Otherwise, the default value `today` is set per the user's\
\ timezone. The value of this field is as follows:\n* For a new subscription\
\ created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate),\
\ this field has the value of the subscription creation date.\n* For a\
\ subscription changed by an amendment, this field has the value of the\
\ amendment booking date.\n* For a subscription created or changed by\
\ an order, this field has the value of the order date. "
format: date
type: string
Name:
description: |2
The unique identifier of the subscription. If you don't specify a value, then Zuora generates a name automatically. Whether auto-generated or manually specified, the subscription name must be unique. Otherwise an error will occur. You can change this value only when the subscription is in `Draft` status. Once the subscription is activated, you can't change this value, nor can you use this value for a different subscription.
**Character limit**: 100
**Values**: one of the following:
- leave null to automatically generate
- a string of 100 characters or fewer
type: string
Notes:
description: " Use this field to record comments about the subscription.\n\
\n\n**Character limit**: 500\n\n\n**Values**: a string of 500 characters\
\ or fewer "
type: string
OriginalCreatedDate:
description: " The date when the subscription was originally created. This\
\ value is the same as the CreatedDate value until the subscription is\
\ amended.\n\n\n\n**Values**: automatically generated "
format: date-time
type: string
OriginalId:
description: " The original ID of this subscription.\n\n\n\n**Values**:\
\ automatically generated "
type: string
PreviousSubscriptionId:
description: " The subscription ID immediately prior to the current subscription.\n\
\n\n**Character limit**: 32\n\n\n**Values**: automatically generated "
type: string
RenewalSetting:
description: " This field can be updated when **Status** is `Draft`. Specifies\
\ whether a termed subscription will remain termed or change to evergreen\
\ when it is renewed.\n\n\nThis field is only required if the `TermType`\
\ field is set to `TERMED`.\n\n\n**Values**: `RENEW_WITH_SPECIFIC_TERM\
\ `(default), `RENEW_TO_EVERGREEN` "
type: string
RenewalTerm:
description: |2
The length of the period for the subscription renewal term. This field can be updated when **Status** is `Draft`. If you use the subscribe
call, this field is required.
This field is only required if the `TermType` field is set to `TERMED`.
**Character limit**: 20
**Values**: one of the following:
- leave null to default to `0`
- any number
format: int32
type: integer
RenewalTermPeriodType:
description: |2
The period type for the subscription renewal term.
**Values**:
- `Month` (default)
- `Year`
- `Day`
- `Week`
**Note**:
- This field is used with the RenewalTerm field to specify the subscription renewal term.
- This field can be updated when Status is `Draft`.
type: string
ServiceActivationDate:
description: |2+
The date when the subscription is activated.
This field can be updated when **Status** is `Draft`. This field is only required if the [Require Service Activation of Orders?](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) Setting is set to `Yes`.
If this setting is set to `Yes`:
- If ContractAcceptanceDate field is required, you must set this field, ContractAcceptanceDate, and ContractEffectiveDate fields in the subscribe call to activate a subscription.
- If ContractAcceptanceDate field is not required, you must set both this field and the ContractEffectiveDate field in the subscribe call to activate a subscription. If you only set a valid date in the ContractEffectiveDate field, the subscribe call still returns success, but the subscription is in `DRAT` status.
**Character limit**: 29
format: date
type: string
Status:
description: |2
The status of the subscription.
**Character limit**: 17
**Values**: automatically generated
**Possible values**: one of the following:
- `Draft`
- `PendingActivation`
- `PendingAcceptance`
- `Active`
- `Cancelled`
- `Expired`
- `Suspended`
type: string
SubscriptionEndDate:
description: " The date when the subscription term ends, where the subscription\
\ ends at midnight the day before. For example, if the SubscriptionEndDate\
\ is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on\
\ 12/30/2016. This date is the same as the term end date or the cancelation\
\ date, as appropriate.\n\n\n**Character limit**: 29\n\n\n**Values**:\
\ automatically generated "
format: date
type: string
SubscriptionStartDate:
description: " The date when the subscription term starts. This date is\
\ the same as the start date of the original term, which isn't necessarily\
\ the start date of the current or new term.\n\n\n**Character limit**:\
\ 29\n\n\n**Values**: automatically generated "
format: date
type: string
TermEndDate:
description: " This field can be updated when **Status** is `Draft`. The\
\ date when the subscription term ends. If the subscription is evergreen,\
\ the TermEndDate value is null or is the cancelation date, as appropriate.\n\
\n**Character limit**: 29\n\n\n**Values**: automatically generated "
format: date
type: string
TermStartDate:
description: " This field can be updated when **Status** is `Draft`. The\
\ date when the subscription term begins. If this is a renewal subscription,\
\ then this date is different from the subscription start date. If you\
\ don't specify a value, then Zuora uses ContractEffectiveDate automatically.\n\
\n\n**Character limit**: 29 "
format: date
type: string
TermType:
description: " This field can be updated when **Status** is `Draft`. Indicates\
\ if a subscription is [termed or evergreen](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions#Termed_and_Evergreen_Subscriptions).\
\ A termed subscription has a specific end date and requires manual renewal.\
\ An evergreen subscription doesn't have an end date and doesn't need\
\ renewal. This field can be updated when the subscription status is Draft.\n\
\n\n**Character limit**: 9\n\n\n**Values**: `TERMED`, `EVERGREEN` "
type: string
UpdatedById:
description: " The ID of the user who last updated the subscription.\n**Character\
\ limit:** 32 **Values: **automatically generated "
type: string
UpdatedDate:
description: " The date when the subscription was last updated.\n**Character\
\ limit:** 29\n\n\n**Values**: automatically generated "
format: date-time
type: string
Version:
description: " The version number of the subscription.\n\n\n\n**Values**:\
\ automatically generated "
format: int32
type: integer
required:
- ContractEffectiveDate
- TermType
type: object
- $ref: '#/definitions/SubscriptionObjectQTFields'
- $ref: '#/definitions/SubscriptionObjectNSFields'
- $ref: '#/definitions/SubscriptionObjectCustomFields'
description: ''
title: Subscription
SubscribeResult:
properties:
AccountId:
description: ''
type: string
AccountNumber:
description: ''
type: string
ChargeMetricsData:
description: ''
properties:
ChargeMetrics:
description: ''
items:
$ref: '#/definitions/NewChargeMetrics'
type: array
type: object
CreditMemoData:
description: |
Container for credit memo data.
**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.
items:
$ref: '#/definitions/ActionSubscribeCreditMemoData'
type: array
CreditMemoId:
description: |
The ID of the credit memo.
**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: string
CreditMemoNumber:
description: |
The number of the credit memo.
**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: string
CreditMemoResult:
description: |
The result of the credit memo.
**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:
CreditMemo:
description: ''
items:
description: ''
properties:
CreditMemoNumber:
description: ''
type: string
Id:
description: ''
type: string
type: object
type: array
title: CreditMemoResult
type: object
Errors:
description: ''
items:
$ref: '#/definitions/ActionsErrorResponse'
type: array
GatewayResponse:
description: ''
type: string
GatewayResponseCode:
description: ''
type: string
InvoiceData:
description: ''
items:
$ref: '#/definitions/ActionSubscribeInvoiceData'
type: array
InvoiceId:
description: ''
type: string
InvoiceNumber:
description: ''
type: string
InvoiceResult:
description: ''
properties:
Invoice:
description: ''
items:
description: ''
properties:
Id:
description: ''
type: string
InvoiceNumber:
description: ''
type: string
type: object
type: array
type: object
PaymentId:
description: ''
type: string
PaymentTransactionNumber:
description: ''
type: string
SubscriptionId:
description: ''
type: string
SubscriptionNumber:
description: ''
type: string
Success:
description: ''
type: boolean
TotalMrr:
description: ''
format: double
type: number
TotalTcv:
description: ''
format: double
type: number
type: object
SubscriptionObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Subscription 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 a Subscription object.
'
title: subscriptionFieldsCustom
type: object
SubscriptionObjectNSFields:
description: 'Container for Subscription fields provided by the [Zuora Connector
for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
properties:
IntegrationId__NS:
description: 'ID of the corresponding object in NetSuite. Only available if
you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
IntegrationStatus__NS:
description: 'Status of the subscription''s synchronization with NetSuite.
Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
Project__NS:
description: 'The NetSuite project that the subscription was created from.
Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
SalesOrder__NS:
description: 'The NetSuite sales order than the subscription was created from.
Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
SyncDate__NS:
description: 'Date when the subscription was synchronized with NetSuite. Only
available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
maxLength: 255
type: string
title: subscriptionFieldsNS
type: object
SubscriptionObjectQTFields:
description: 'Container for Subscription fields provided by Zuora Quotes.
'
properties:
CpqBundleJsonId__QT:
description: 'The Bundle product structures from Zuora Quotes if you utilize
Bundling in Salesforce. Do not change the value in this field.
'
maxLength: 32
type: string
OpportunityCloseDate__QT:
description: 'The closing date of the Opportunity. This field is used in Zuora
data sources to report on Subscription metrics. If the subscription originated
from Zuora Quotes, the value is populated with the value from Zuora Quotes.
'
format: date
type: string
OpportunityName__QT:
description: 'The unique identifier of the Opportunity. This field is used
in Zuora data sources to report on Subscription metrics. If the subscription
originated from Zuora Quotes, the value is populated with the value from
Zuora Quotes.
'
maxLength: 100
type: string
QuoteBusinessType__QT:
description: 'The specific identifier for the type of business transaction
the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This
field is used in Zuora data sources to report on Subscription metrics. If
the subscription originated from Zuora Quotes, the value is populated with
the value from Zuora Quotes.
'
maxLength: 32
type: string
QuoteNumber__QT:
description: 'The unique identifier of the Quote. This field is used in Zuora
data sources to report on Subscription metrics. If the subscription originated
from Zuora Quotes, the value is populated with the value from Zuora Quotes.
'
maxLength: 32
type: string
QuoteType__QT:
description: 'The Quote type that represents the subscription lifecycle stage
such as New, Amendment, Renew or Cancel. This field is used in Zuora data
sources to report on Subscription metrics. If the subscription originated
from Zuora Quotes, the value is populated with the value from Zuora Quotes.
'
maxLength: 32
type: string
title: subscriptionFieldsQT
type: object
SubscriptionProductFeature:
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\n**Values**: "
format: date-time
type: string
Description:
description: " Description of the subscription product feature.\n\n\n**Character\
\ limit**: 500\n\n\n**Values**: "
type: string
FeatureCode:
description: " Unique code of the feature.\n\n\n**Character limit**: 255\n\
\n\n**Values**: "
type: string
FeatureId:
description: " Internal Zuora ID of the feature.\n\n\n**Character limit**:\
\ 32\n\n\n**Values**: "
type: string
Name:
description: " Name of the feature.\n\n\n**Character limit**: 255\n\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\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\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\n**Values**: "
format: date-time
type: string
required:
- FeatureId
type: object
- $ref: '#/definitions/SubscriptionProductFeatureObjectCustomFields'
SubscriptionProductFeatureList:
properties:
SubscriptionProductFeature:
description: ''
items:
$ref: '#/definitions/ActionAmendSubscriptionProductFeature'
type: array
type: object
SubscriptionProductFeatureObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Subscription Product Feature 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 a Subscription Product Feature object.
'
title: subscriptionProductFeatureFieldsCustom
type: object
TaxInfo:
description: 'Information about the tax exempt status of a customer account.
'
properties:
VATId:
description: |
EU Value Added Tax ID.
**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).
maxLength: 25
type: string
companyCode:
description: |
Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara.
**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).
maxLength: 50
type: string
exemptCertificateId:
description: 'ID of the customer tax exemption certificate. Applicable if
you use Zuora Tax or Connect tax engines.
'
maxLength: 32
type: string
exemptCertificateType:
description: 'Type of tax exemption certificate that the customer holds. Applicable
if you use Zuora Tax or Connect tax engines.
'
maxLength: 32
type: string
exemptDescription:
description: 'Description of the tax exemption certificate that the customer
holds. Applicable if you use Zuora Tax or Connect tax engines.
'
maxLength: 500
type: string
exemptEffectiveDate:
description: 'Date when the customer tax exemption starts, in YYYY-MM-DD format.
Applicable if you use Zuora Tax or Connect tax engines.
'
format: date
type: string
exemptExpirationDate:
description: 'Date when the customer tax exemption expires, in YYYY-MM-DD
format. Applicable if you use Zuora Tax or Connect tax engines.
'
format: date
type: string
exemptIssuingJurisdiction:
description: 'Jurisdiction in which the customer tax exemption certificate
was issued.
'
maxLength: 32
type: string
exemptStatus:
default: 'No'
description: "Status of the account tax exemption. Applicable if you use Zuora\
\ Tax or Connect tax engines. Required if you use Zuora Tax. \n"
enum:
- 'No'
- 'Yes'
- PendingVerification
type: string
title: taxInfo
type: object
TaxationItemObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Taxation Item 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 a Taxation Item object.
'
title: taxationItemFieldsCustom
type: object
Term:
description: 'List of terms for the subscription.
'
properties:
endDate:
description: 'The end date of the term.
'
format: date
type: string
isEvergreen:
description: 'Indicates whether the term is evergreen.
'
type: boolean
startDate:
description: 'The start date of the term.
'
format: date
type: string
termNumber:
description: 'The term number.
'
format: long
type: number
type: object
TermsAndConditions:
description: 'Information about an order action of type `TermsAndConditions`.
'
properties:
autoRenew:
type: boolean
billToContactId:
description: |
The ID of the bill-to contact associated with the subscription.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
clearingExistingBillToContact:
default: false
description: |
Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `paymentTerm` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingInvoiceTemplate:
default: false
description: |
Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingPaymentTerm:
default: false
description: |
Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `billToContactId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
clearingExistingSequenceSet:
default: false
description: |
Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.
**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
type: boolean
initialTerm:
$ref: '#/definitions/InitialTerm'
invoiceTemplateId:
description: |
The ID of the invoice template associated with the subscription.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
paymentTerm:
description: |
The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
renewalSetting:
enum:
- RENEW_WITH_SPECIFIC_TERM
- RENEW_TO_EVERGREEN
type: string
renewalTerms:
items:
$ref: '#/definitions/RenewalTerm'
type: array
sequenceSetId:
description: |
The ID of the sequence set associated with the subscription.
**Note**:
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
type: string
title: termsAndConditions
type: object
TimeSlicedMetricsForEvergreen:
properties:
amount:
type: number
endDate:
format: date
type: string
invoiceOwner:
description: The acount number of the billing account that is billed for the
subscription.
type: string
startDate:
format: date
type: string
subscriptionOwner:
description: The acount number of the billing account that owns the subscription.
type: string
termNumber:
format: long
type: number
type: object
TimeSlicedNetMetricsForEvergreen:
properties:
amount:
type: number
discountChargeNumber:
type: string
endDate:
format: date
type: string
invoiceOwner:
description: The acount number of the billing account that is billed for the
subscription.
type: string
startDate:
format: date
type: string
subscriptionOwner:
description: The acount number of the billing account that owns the subscription.
type: string
termNumber:
format: long
type: number
type:
description: Indicates whether this metrics is for a regular charge or a discount.
charge.
enum:
- Regular
- Discount
type: string
type: object
TimeSlicedTcbNetMetricsForEvergreen:
properties:
amount:
type: number
discountChargeNumber:
type: string
endDate:
format: date
type: string
invoiceOwner:
description: The acount number of the billing account that is billed for the
subscription.
type: string
startDate:
format: date
type: string
subscriptionOwner:
description: The acount number of the billing account that owns the subscription.
type: string
tax:
type: number
termNumber:
format: long
type: number
type:
description: Indicates whether this metrics is for a regular charge or a discount.
charge.
enum:
- Regular
- Discount
type: string
type: object
TriggerDate:
properties:
name:
description: 'Name of the trigger date of the order action.
'
enum:
- ContractEffective
- ServiceActivation
- CustomerAcceptance
type: string
triggerDate:
description: 'Trigger date in YYYY-MM-DD format.
'
format: date
type: string
title: triggerDate
type: object
TriggerParams:
description: 'Specifies when a charge becomes active.
'
properties:
specificTriggerDate:
description: "Date in YYYY-MM-DD format. Only applicable if the value of the\
\ `triggerEvent` field is `SpecificDate`. \n\nWhile this field is applicable,\
\ if this field is not set, your `CreateSubscription` order action creates\
\ a `Pending` order and a `Pending Acceptance` subscription. If at the same\
\ time the service activation date is required and not set, a `Pending Activation`\
\ subscription is created.\n\nWhile this field is applicable, if this field\
\ is not set, the following order actions create a `Pending` order but do\
\ not impact the subscription status. **Note**: This feature is in **Limited\
\ Availability**. If you want to have access to the feature, submit a request\
\ at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n\
\ * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
format: date
type: string
triggerEvent:
description: |
Condition for the charge to become active.
If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.
enum:
- ContractEffective
- ServiceActivation
- CustomerAcceptance
- SpecificDate
type: string
title: startDate
type: object
UpdateEntityResponseType:
properties:
success:
description: Returns `true` if the request is successful.
type: boolean
type: object
UpdateEntityType:
example:
displayName: Acme-Italy
locale: en_GB
name: Acme-Italy
timezone: Europe/Rome
properties:
displayName:
description: |-
The display name of the entity that is shown in the Zuora UI and APIs
**Note:** If you do not specify the display name in the request, the entity name is used as the display name.
maxLength: 255
type: string
locale:
description: The locale that is used in this entity.
type: string
name:
description: "The name of the entity that is the entity identifier and is\
\ unique across all entities in a multi-entity hierarchy.\n\n**Note:** Only\
\ alphanumeric characters (letters A\u2013Z and a\u2013z, and digits 0\u2013\
9), space, period, and hyphen are allowed to be used in entity names. "
maxLength: 255
type: string
timezone:
description: The time zone that is used in this entity.
type: string
type: object
UsageFlatFeePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
description: 'Price of the charge.
'
type: number
type: object
description: 'Pricing information about a usage charge that uses the "flat fee"
charge model. In this charge model, the charge has a fixed price.
'
title: usageFlatFee
UsageFlatFeePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
type: number
type: object
UsageOveragePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
includedUnits:
description: 'Number of free units that may be consumed.
'
minimum: 0
type: number
numberOfPeriods:
description: 'Number of periods that Zuora considers when calculating overage
charges with overage smoothing.
'
minimum: 1
type: integer
overagePrice:
description: 'Price per overage unit consumed.
'
type: number
overageUnusedUnitsCreditOption:
description: |
Specifies whether to credit the customer for unused units.
If the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.
enum:
- NoCredit
- CreditBySpecificRate
type: string
unusedUnitsCreditRates:
description: 'Per-unit rate at which to credit the customer for unused units.
Only applicable if the value of the `overageUnusedUnitsCreditOption` field
is `CreditBySpecificRate`.
'
type: number
type: object
description: 'Pricing information about a usage charge that uses the "overage"
charge model. In this charge model, the charge has an allowance of free units
and a fixed price per additional unit consumed.
'
title: usageOverage
UsageOveragePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
includedUnits:
description: 'A certain quantity of units for free in the overage charge
model. It cannot be negative. It must be 0 and above. Decimals are allowed.
'
type: number
overagePrice:
type: number
type: object
UsagePerUnitPricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
description: 'Per-unit price of the charge.
'
type: number
ratingGroup:
description: "Specifies how Zuora groups usage records when rating usage.\
\ See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group)\
\ for more information.\n * ByBillingPeriod (default): The rating is\
\ based on all the usages in a billing period.\n * ByUsageStartDate:\
\ The rating is based on all the usages on the same usage start date.\
\ \n * ByUsageRecord: The rating is based on each usage record.\n *\
\ ByUsageUpload: The rating is based on all the usages in a uploaded usage\
\ file (.xls or .csv). If you import a mass usage in a single upload,\
\ which contains multiple usage files in .xls or .csv format, usage records\
\ are grouped for each usage file.\n"
enum:
- ByBillingPeriod
- ByUsageStartDate
- ByUsageRecord
- ByUsageUpload
type: string
type: object
description: 'Pricing information about a usage charge that uses the "per unit"
charge model. In this charge model, the charge has a fixed price per unit consumed.
'
title: usagePerUnit
UsagePerUnitPricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
listPrice:
type: number
type: object
UsageTieredPricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
ratingGroup:
description: "Specifies how Zuora groups usage records when rating usage.\
\ See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group)\
\ for more information.\n * ByBillingPeriod (default): The rating is\
\ based on all the usages in a billing period.\n * ByUsageStartDate:\
\ The rating is based on all the usages on the same usage start date.\
\ \n * ByUsageRecord: The rating is based on each usage record.\n *\
\ ByUsageUpload: The rating is based on all the usages in a uploaded usage\
\ file (.xls or .csv). If you import a mass usage in a single upload,\
\ which contains multiple usage files in .xls or .csv format, usage records\
\ are grouped for each usage file.\n"
enum:
- ByBillingPeriod
- ByUsageStartDate
- ByUsageRecord
- ByUsageUpload
type: string
tiers:
description: 'List of cumulative pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
description: 'Pricing information about a usage charge that uses the "tiered pricing"
charge model. In this charge model, the charge has cumulative pricing tiers
that become effective as units are consumed.
'
title: usageTiered
UsageTieredPricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
tiers:
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
UsageTieredWithOveragePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
numberOfPeriods:
description: 'Number of periods that Zuora considers when calculating overage
charges with overage smoothing.
'
minimum: 1
type: integer
overagePrice:
description: 'Price per overage unit consumed.
'
type: number
overageUnusedUnitsCreditOption:
description: |
Specifies whether to credit the customer for unused units.
If the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.
enum:
- NoCredit
- CreditBySpecificRate
type: string
tiers:
description: 'List of cumulative pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
unusedUnitsCreditRates:
description: 'Per-unit rate at which to credit the customer for unused units.
Only applicable if the value of the `overageUnusedUnitsCreditOption` field
is `CreditBySpecificRate`.
'
type: number
type: object
description: 'Pricing information about a usage charge that uses the "tiered with
overage" charge model. In this charge model, the charge has cumulative pricing
tiers that become effective as units are consumed. The charge also has a fixed
price per unit consumed beyond the limit of the final tier.
'
title: usageTieredWithOverage
UsageTieredWithOveragePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
overagePrice:
type: number
tiers:
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
UsageVolumePricingOverride:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
ratingGroup:
description: "Specifies how Zuora groups usage records when rating usage.\
\ See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group)\
\ for more information.\n * ByBillingPeriod (default): The rating is\
\ based on all the usages in a billing period.\n * ByUsageStartDate:\
\ The rating is based on all the usages on the same usage start date.\
\ \n * ByUsageRecord: The rating is based on each usage record.\n *\
\ ByUsageUpload: The rating is based on all the usages in a uploaded usage\
\ file (.xls or .csv). If you import a mass usage in a single upload,\
\ which contains multiple usage files in .xls or .csv format, usage records\
\ are grouped for each usage file.\n"
enum:
- ByBillingPeriod
- ByUsageStartDate
- ByUsageRecord
- ByUsageUpload
type: string
tiers:
description: 'List of variable pricing tiers in the charge.
'
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
description: 'Pricing information about a usage charge that uses the "volume pricing"
charge model. In this charge model, the charge has a variable price per unit,
depending on how many units are consumed.
'
title: usageVolume
UsageVolumePricingUpdate:
allOf:
- $ref: '#/definitions/PriceChangeParams'
- properties:
tiers:
items:
$ref: '#/definitions/ChargeTier'
type: array
type: object
creditCard:
description: |
Default payment method associated with an account. Only credit card payment methods are supported.
properties:
cardHolderInfo:
$ref: '#/definitions/AccountCreditCardHolder'
cardNumber:
description: 'Card number. Once set, you cannot update or query the value
of this field. The value of this field is only available in masked format.
For example, XXXX-XXXX-XXXX-1234 (hyphens must not be used when you set
the credit card number).
'
type: string
cardType:
description: 'Type of card.
'
enum:
- Visa
- MasterCard
- AmericanExpress
- Discover
- JCB
- Diners
- CUP
- Maestro
- Electron
- AppleVisa
- AppleMasterCard
- AppleAmericanExpress
- AppleDiscover
- AppleJCB
- Elo
- Hipercard
- Naranja
- Nativa
- TarjetaShopping
- Cencosud
- Argencard
- Cabal
type: string
expirationMonth:
description: 'Expiration date of the card.
'
maximum: 12
minimum: 1
type: integer
expirationYear:
description: 'Expiration year of the card.
'
maximum: 2500
minimum: 1980
type: integer
securityCode:
description: 'CVV or CVV2 security code of the card. To ensure PCI compliance,
Zuora does not store the value of this field.
'
type: string
type: object
zObject:
additionalProperties:
description: 'Field of the object.
'
type: object
GetReportRunResponse:
type: object
properties:
id:
type: string
description: |
The ID of the report run. This value matches the value of the `reportRunId` request parameter.
status:
type: string
enum:
- started
- querydata
- processingdata
- completed
- cancelled
- invalid
- error
description: |
Status of the report run.
* `started` - The report run has started. The query has not been submitted.
* `querydata` - The query has been submitted. The results have not been received.
* `processingdata` - The results have been received. The results are being processed.
* `completed` - The report run has finished successfully. The results are available for download using Get Report Data or Export Report Run.
* `cancelled` - The report run was canceled by the user.
* `invalid` - The report definition or data is invalid.
* `error` - The report run has finished with an error.
startedOn:
type: string
format: date-time
description: |
The timestamp of when the report run was started.
updatedOn:
type: string
format: date-time
description: |
The timestamp of when the status of the report run was last updated.
reportID:
type: string
description: |
The ID of the report that was run.
reportType:
type: string
enum:
- detail
- summary
description: |
The type of the report that was run.
reportDefinition:
type: string
description: |
The definition of the report that was run.
ProxyCreateBillRun:
example:
{
"Batch": "Batch1",
"InvoiceDate": "2017-02-04",
"TargetDate": "2017-02-04"
}
type: object
required:
- InvoiceDate
- TargetDate
properties:
AccountId:
description: |
ID of the account used for single account bill run.
This field is only required if you create ad hoc bill run for a single customer account.
**Character limit:** 32
type: string
InvoiceDate:
description: |
Invoice date for this bill run.
**Character limit:** 29
type: string
format: date
TargetDate:
description: |
Target date for this bill run. See [Create Bill Run](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs) for more information.
**Character limit:** 29
type: string
format: date
AutoEmail:
description: |
Determines whether to auto send email or not by this bill run once the bill run completes.
**Note:** You must enable the [Support Bill Run Auto-Post Billing](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Billing_Rules) rule to pass this field.
type: boolean
default: false
AutoRenewal:
description: |
Determines whether to auto renew subscription or not by this bill run once the bill run completes.
type: boolean
default: false
AutoPost:
description: |
Determines whether to auto post bill run or not once the bill run completes.
**Note:** You must enable the [Support Bill Run Auto-Post Billing](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Billing_Rules) rule to pass this field.
type: boolean
default: false
ChargeTypeToExclude:
description: |
Charge type or types to be excluded, separated with comma.
**Possible Values:** `OneTime`, `Recurring`, `Usage`, or a combination of these values.
**Character limit:** 50
type: string
NoEmailForZeroAmountInvoice:
description: |
Determines whether to suppress email for invoices with zero total or not for this bill run once the bill run completes. (Do not email invoices with 0 Invoice Total).
type: boolean
default: false
Batch:
description: |
Batch of accounts for this bill run.
When creating ad hoc bill run for multiple customer accounts, this field is only required if the `BillCycleDay`
field is not specified.
**Character limit:** 20
**Values:** AllBatches or Batchn where n is a number between 1 and 50.
**Note**:
- By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
- To use this field, you must set the `X-Zuora-WSDL-Version` request header to `101` or earlier. Otherwise, an error occurs.
type: string
default: AllBatches
Batches:
description: |
The specific batches of customer accounts to be included in the bill run.
You cannot set the `Batches` field to a value consisting of both `AllBatches` and `Batch`*n*. Otherwise, the `INVALID_VALUE` error occurs. For example, `AllBatches,Batch3` is an invalid value for this field. Batch of accounts for this bill run.
**Character limit:** 20
**Values:** `AllBatches`, `Batch`*n* or an array of `Batch`*n* where *n* is a number between 1 and 50
**Note**:
- By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
- To use this field, you must set the `X-Zuora-WSDL-Version` request header to `102` or later. Otherwise, an error occurs.
type: string
default: AllBatches
BillCycleDay:
description: |
The day of the bill cycle.
When creating ad hoc bill run for multiple customer accounts, this field is only required if the `Batch` field is not specified.
**Character limit:** 32
**Values:** `AllBillCycleDays` or 01 - 31.
type: string
ProxyGetBillRun:
type: object
properties:
Id:
description: |
ID of the object.
**Character limit:** 32
**Values:** automatically generated
type: string
AutoEmail:
description: |
Determines whether to auto send email or not once the bill run completes.
**Note:** You must enable the [Support Bill Run Auto-Post Billing](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Billing_Rules) rule to pass this field.
type: boolean
AutoPost:
description: |
Determines whether to auto post bill run or not once the bill run completes.
**Note:** You must enable the [Support Bill Run Auto-Post Billing](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Billing_Rules) rule to pass this field.
type: boolean
AutoRenewal:
description: |
Determines whether to auto renew subscription or not by this bill run once the bill run completes.
type: boolean
Batch:
description: |
Batch of accounts for this bill run.
**Character limit:** 20
**Values:** AllBatches or Batchn where n is a number between 1 and 50.
type: string
Batches:
description: |
The specific batches of customer accounts to be included in the bill run.
**Note**: To use this field, you must set the `X-Zuora-WSDL-Version` request header to `102` or later. Otherwise, an error occurs.
**Character limit:** 20
**Values:** `AllBatches`, `Batch`*n* or an array of `Batch`*n* where *n* is a number between 1 and 50
type: string
BillCycleDay:
description: |
The day of the bill cycle.
**Character limit:** 32
**Values:** `AllBillCycleDays` or 01 - 31.
type: string
BillRunNumber:
description: |
Number of the bill run.
**Character limit:** 50
**Values:** automatically generated
type: string
CreatedById:
description: |
The user ID of the person who created the bill run.
**Character limit:** 32
**Values:** automatically generated
type: string
CreatedDate:
description: |
The date and time when the bill run was created.
**Character limit:** 29
**Values:** automatically generated
type: string
format: date-time
NoEmailForZeroAmountInvoice:
description: |
Determines whether to suppress email for invoices with zero total or not for this bill run once the bill run completes. (Do not email invoices with 0 Invoice Total).
type: boolean
ExecutedDate:
description: |
The date and time when the bill run was executed.
type: string
format: date-time
InvoiceDate:
description: |
Invoice date for this bill run.
**Character limit:** 29
type: string
format: date
InvoicesEmailed:
description: |
Indicates whether the invoice has been sent or not.
**Values:** automatically generated
type: boolean
LastEmailSentTime:
description: |
The last time emails were sent for this bill run.
**Character limit:** 29
**Values:** automatically generated
type: string
format: date-time
NumberOfAccounts:
description: |
The number of accounts processed by this bill run.
**Values:** automatically generated
type: integer
format: int64
NumberOfInvoices:
description: |
The number of invoices generated by this run.
**Values:** automatically generated
type: integer
format: int64
AccountId:
description: |
ID of the account used for single account bill run.
**Character limit:** 32
type: string
Status:
description: |
The status for this bill run. See [Status Types](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/G_Bill_Runs#Status_Types) for more information.
enum:
- Pending
- Processing
- Completed
- Error
- Canceled
- Posted
- PostInProgress
- CancelInProgress
- RemoveInProgress
- Paused
type: string
TargetDate:
description: |
Target date for this bill run. See [Create Bill Run](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs) for more information.
**Character limit:** 29
type: string
format: date
UpdatedById:
description: |
The user ID of the person who last updated the bill run.
**Character limit:** 32
**Values:** automatically generated
type: string
UpdatedDate:
description: |
The date and time when the bill run was last updated.
**Character limit:** 29
**Values:** automatically generated
type: string
format: date-time
ProxyModifyBillRun:
example:
{
"Status":"Posted",
"InvoiceDate":"2020-02-18"
}
type: object
required:
- Status
properties:
Status:
description: |
The status for this bill run. See [Status Types](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/G_Bill_Runs#Status_Types) for more information.
To cancel a bill run, specify `Canceled`. To post a bill run, specify `Posted`.
**Character limit:** 20
**Values:**
* `Pending`
* `Processing`
* `Completed`
* `Error`
* `Canceled`
* `Posted`
type: string
InvoiceDate:
type: string
format: date
description: |
The new invoice date of all invoices invloved in the bill run, or the new memo date of all credit memos invloved in the bill run. The date cannot fall in a closed accounting period.
This field takes effect only when `Status` is set to `Posted`.
**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
ProxyGetInvoice:
allOf:
- type: object
properties:
Id:
description: "Object identifier."
type: string
AccountId:
description: ""
type: string
AdjustmentAmount:
description: " The amount of the invoice adjustments associated with the invoice.
**Character limi**t: 16
**Values**: a valid currency amount
"
type: number
format: double
Amount:
description: " The sum of all charges and taxes associated with the invoice.
**Character limit**: 16
**Values**: automatically generated
"
type: number
format: double
AmountWithoutTax:
description: " The sum of all charges associated with the invoice. Taxes are excluded from this value.
**Character limit**: 16
**Values**: automatically generated
"
type: number
format: double
Balance:
description: " The remaining balance of the invoice after all payments, adjustments, and refunds are applied.
**Character limit**: 16
**Values**: automatically generated
"
type: number
format: double
BillToContactId:
type: string
description: |
The ID of bill-to contact associated with the invoice.
**Note**: This field is available only if you set the `X-Zuora-WSDL-Version` request header to `118` or later. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.
Body:
description: " Required
"
type: string
Comments:
description: " Additional information related to the invoice that a Zuora user added to the invoice.
**Character limit**: 255
**Values:** a string of 255 characters or fewer
"
type: string
CreatedById:
description: " The user ID of the person who created the invoice. If a bill run generated the invoice, then the value is the user ID of person who created the bill run.
**Character limit**: 32
**Values**: automatically generated
"
type: string
CreatedDate:
description: " The date when the invoice was generated.
**Character limit**: 29
**Values**: automatically generated
"
type: string
format: date-time
CreditBalanceAdjustmentAmount:
description: " The currency amount of the adjustment applied to the customer's credit balance.
**Character limit**: 16
**Values**: a valid currency amount
This field is only available if the [Zuora Global Support](http://support.zuora.com/) to enable this feature.
"
type: number
format: double
CreditMemoAmount:
description: |
The currency amount of all credit memos applied to this invoice.
**Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
type: number
format: double
DueDate:
description: " The date by which the payment for this invoice is due.
**Character limit**: 29
**Version notes**: --
"
type: string
format: date
IncludesOneTime:
description: |
Whether the bill run picks up all one-time charges for processing. You can use this field only with the Generate call for the Invoice object.
type: boolean
default: True
IncludesRecurring:
description: |
Whether the bill run picks up all recurring charges for processing. You can use this field only with the Generate call for the Invoice object.
type: boolean
default: True
IncludesUsage:
description: |
Whether the bill run picks up all usage charges for processing. You can use this field only with the Generate call for the Invoice object.
type: boolean
default: True
InvoiceDate:
description: " Specifies the date on which to generate the invoice.
**Character limit**: 29
**Version notes**: --
"
type: string
format: date
InvoiceNumber:
description: " The unique identification number for the invoice. This number is returned as a string.
**Character limit**: 32
**Values**: automatically generated
"
type: string
LastEmailSentDate:
description: " The date when the invoice was last emailed.
**Character limit**: 29
**Values**: automatically generated
"
type: string
format: date-time
PaymentAmount:
description: " The amount of payments applied to the invoice.
**Character limit**: 16
**Value**s: automatically generated
"
type: number
format: double
PaymentTerm:
type: string
description: |
The name of payment term associated with the invoice.
**Note**:
- This field is available only if you set the `X-Zuora-WSDL-Version` request header to `118` or later.
- If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.
- If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
PostedBy:
description: " The user ID of the person who moved the invoice to Posted status.
**Character limit**: 32
**Values**: automatically generated
"
type: string
PostedDate:
description: " The date when the invoice was posted.
**Character limit:** 29
**Values**: automatically generated
"
type: string
format: date-time
RefundAmount:
description: " Specifies the amount of a refund that was applied against an earlier payment on the invoice.
**Character limit**: 16
**Values**: automatically generated
"
type: number
format: double
SequenceSetId:
type: string
description: |
The ID of the sequence set associated with the invoice.
**Note**: This field is available only if you set the `X-Zuora-WSDL-Version` request header to `127` or later. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.
Status:
description: " The status of the invoice in the system. This status is not the status of the payment of the invoice, just the status of the invoice itself.
**Character limit**: 8
**Values**: one of the following:
- Draft (default, automatically set upon invoice creation)
- Posted
- Canceled
"
type: string
SourceType:
description: " The type of the invoice source.
**Note**: To use this field, you must set the `X-Zuora-WSDL-Version` request header to `118` or later. Otherwise, an error occurs.
**Character limit**: 16
**Values**: one of the following enum values:
- Subscription
- Standalone
- Order
- Consolidation
"
type: string
TargetDate:
description: " This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run.
**Character limit**: 29
**Version notes**: --
"
type: string
format: date
TaxAmount:
description: " The total amount of the taxes applied to the invoice.
**Character limit**: 16
**Values**: automatically generated
"
type: number
format: double
TaxExemptAmount:
description: " The total amount of the invoice that is exempt from taxation.
**Character limit**: 16
**Values**: automatically generated
"
type: number
format: double
TransferredToAccounting:
description: " Specifies whether or not the invoice was transferred to an external accounting system, such as NetSuite.
**Character limit**: 10
**Values**: Processing, Yes, Error, Ignore
"
type: string
UpdatedById:
description: ""
type: string
UpdatedDate:
description: " The date when the invoice was last updated.
**Character limit**: 29
**Values**: automatically generated
"
type: string
format: date-time
- $ref: '#/definitions/InvoiceObjectNSFields'
- $ref: '#/definitions/InvoiceObjectCustomFields'
ProxyCreateContact:
example:
{
"AccountId": "8ad09be48db5aba7018db604776d4854",
"FirstName": "Amy",
"LastName": "Lawrence"
}
allOf:
- type: object
properties:
AccountId:
description: " The Zuora account ID associated with this contact. This field is not required when you use the Subscribe call. This field is required for all other calls.
**Character limit: **32
**Values: **a valid account ID
"
type: string
Address1:
description: " The first line of the contact's address, which is often a street address or business name.
**Character limit**: 255
**Values**: a string of 255 characters or fewer
"
type: string
Address2:
description: " The second line of the contact's address.
**Character limit**: 255
**Values**: a string of 255 characters or fewer
"
type: string
City:
description: " The city of the contact's address.
**Character limit**: 40
**Values: **a string of 40 characters or fewer
"
type: string
Country:
description: " The country of the contact's address.
"
type: string
County:
description: " The county. May optionally be used by Zuora Tax to calculate county tax.
**Character limit**: 32
**Values**: a string of 32 characters or fewer
"
type: string
Description:
description: " A description for the contact.
**Character limit**: 100
**Values**: a string of 100 characters or fewer
"
type: string
Fax:
description: " The contact's fax number.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
FirstName:
description: " The contact's first name.
**Character limit**: 100
**Values**: a string of the contact's first name
"
type: string
HomePhone:
description: " The contact's home phone number.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
LastName:
description: " The contact's last name.
**Character limit**: 100
**Values**: a string of 100 characters or fewer
"
type: string
MobilePhone:
description: " The contact's mobile phone number.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
NickName:
description: " A nickname for the contact.
**Character limit**: 100
**Values**: a string of 100 characters or fewer
"
type: string
OtherPhone:
description: " An additional phone number for the contact.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
OtherPhoneType:
description: "The type of the `OtherPhone`.
**Character limit**: 20
**Values**: `Work`, `Mobile`, `Home`, `Other`
"
type: string
PersonalEmail:
description: " The contact's personal email address.
**Character limit**: 80
**Values**: a string of 80 characters or fewer
"
type: string
PostalCode:
description: " The zip code for the contact's address.
**Character limit:** 20
**Values: **a string of 20 characters or fewer
"
type: string
State:
description: " The state or province of the contact's address.
"
type: string
TaxRegion:
description: "If using Zuora Tax rules
"
type: string
WorkEmail:
description: " The contact's business email address.
**Character limit**: 80
**Values**: a string of 80 characters or fewer
"
type: string
WorkPhone:
description: " The contact's business phone number.
**Character limit**: 40
**notes**: --
**Values**: a string of 40 characters or fewer
"
type: string
required:
- AccountId
- FirstName
- LastName
- $ref: '#/definitions/ContactObjectCustomFields'
ProxyModifyContact:
example:
{
"Country": "United States",
"State": "CA"
}
allOf:
- type: object
properties:
AccountId:
description: " The Zuora account ID associated with this contact. This field is not required when you use the Subscribe call. This field is required for all other calls.
**Character limit: **32
**Values: **a valid account ID
"
type: string
Address1:
description: " The first line of the contact's address, which is often a street address or business name.
**Character limit**: 255
**Values**: a string of 255 characters or fewer
"
type: string
Address2:
description: " The second line of the contact's address.
**Character limit**: 255
**Values**: a string of 255 characters or fewer
"
type: string
City:
description: " The city of the contact's address.
**Character limit**: 40
**Values: **a string of 40 characters or fewer
"
type: string
Country:
description: " The country of the contact's address.
"
type: string
County:
description: " The county. May optionally be used by Zuora Tax to calculate county tax.
**Character limit**: 32
**Values**: a string of 32 characters or fewer
"
type: string
Description:
description: " A description for the contact.
**Character limit**: 100
**Values**: a string of 100 characters or fewer
"
type: string
Fax:
description: " The contact's fax number.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
FirstName:
description: " The contact's first name.
**Character limit**: 100
**Values**: a string of the contact's first name
"
type: string
HomePhone:
description: " The contact's home phone number.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
LastName:
description: " The contact's last name.
**Character limit**: 100
**Values**: a string of 100 characters or fewer
"
type: string
MobilePhone:
description: " The contact's mobile phone number.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
NickName:
description: " A nickname for the contact.
**Character limit**: 100
**Values**: a string of 100 characters or fewer
"
type: string
OtherPhone:
description: " An additional phone number for the contact.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
OtherPhoneType:
description: "The type of the `OtherPhone`.
**Character limit**: 20
**Values**: `Work`, `Mobile`, `Home`, `Other`
"
type: string
PersonalEmail:
description: " The contact's personal email address.
**Character limit**: 80
**Values**: a string of 80 characters or fewer
"
type: string
PostalCode:
description: " The zip code for the contact's address.
**Character limit:** 20
**Values: **a string of 20 characters or fewer
"
type: string
State:
description: " The state or province of the contact's address.
"
type: string
TaxRegion:
description: "If using Zuora Tax rules
"
type: string
WorkEmail:
description: " The contact's business email address.
**Character limit**: 80
**Values**: a string of 80 characters or fewer
"
type: string
WorkPhone:
description: " The contact's business phone number.
**Character limit**: 40
**notes**: --
**Values**: a string of 40 characters or fewer
"
type: string
- $ref: '#/definitions/ContactObjectCustomFields'
ProxyGetContact:
allOf:
- type: object
properties:
Id:
description: "Object identifier."
type: string
AccountId:
description: " The Zuora account ID associated with this contact. This field is not required when you use the Subscribe call. This field is required for all other calls.
**Character limit: **32
**Values: **a valid account ID
"
type: string
Address1:
description: " The first line of the contact's address, which is often a street address or business name.
**Character limit**: 255
**Values**: a string of 255 characters or fewer
"
type: string
Address2:
description: " The second line of the contact's address.
**Character limit**: 255
**Values**: a string of 255 characters or fewer
"
type: string
City:
description: " The city of the contact's address.
**Character limit**: 40
**Values: **a string of 40 characters or fewer
"
type: string
Country:
description: " The country of the contact's address.
"
type: string
County:
description: " The county. May optionally be used by Zuora Tax to calculate county tax.
**Character limit**: 32
**Values**: a string of 32 characters or fewer
"
type: string
CreatedById:
description: "The ID of the Zuora user who created the contact.
**Character limit**: 32
**Values**: automatically generated
"
type: string
CreatedDate:
description: "The date when the contact was created.
**Character limit**: 29
**Values**: automatically generated
"
type: string
format: date-time
Description:
description: " A description for the contact.
**Character limit**: 100
**Values**: a string of 100 characters or fewer
"
type: string
Fax:
description: " The contact's fax number.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
FirstName:
description: " The contact's first name.
**Character limit**: 100
**Values**: a string of the contact's first name
"
type: string
HomePhone:
description: " The contact's home phone number.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
LastName:
description: " The contact's last name.
**Character limit**: 100
**Values**: a string of 100 characters or fewer
"
type: string
MobilePhone:
description: " The contact's mobile phone number.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
NickName:
description: " A nickname for the contact.
**Character limit**: 100
**Values**: a string of 100 characters or fewer
"
type: string
OtherPhone:
description: " An additional phone number for the contact.
**Character limit**: 40
**Values**: a string of 40 characters or fewer
"
type: string
OtherPhoneType:
description: "The type of the `OtherPhone`.
**Character limit**: 20
**Values**: `Work`, `Mobile`, `Home`, `Other`
"
type: string
PersonalEmail:
description: " The contact's personal email address.
**Character limit**: 80
**Values**: a string of 80 characters or fewer
"
type: string
PostalCode:
description: " The zip code for the contact's address.
**Character limit:** 20
**Values: **a string of 20 characters or fewer
"
type: string
State:
description: " The state or province of the contact's address.
"
type: string
TaxRegion:
description: "If using Zuora Tax rules
"
type: string
UpdatedById:
description: " The ID of the user who lasted updated the contact.
**Character limit**: 32
**Values**: automatically generated
"
type: string
UpdatedDate:
description: " The date when the contact was last updated.
**Character limit**: 29
**Values**: automatically generated
"
type: string
format: date-time
WorkEmail:
description: " The contact's business email address.
**Character limit**: 80
**Values**: a string of 80 characters or fewer
"
type: string
WorkPhone:
description: " The contact's business phone number.
**Character limit**: 40
**notes**: --
**Values**: a string of 40 characters or fewer
"
type: string
- $ref: '#/definitions/ContactObjectCustomFields'