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: Subscriptions - description: | An omnichannel subscription is a subscription originating from external and source systems, such as the Apple App Store, Google Play Store, and Roku Store. To create, update, delete, or retrieve an omnichannel subscription, you must turn on the Omni-Channel Subscription feature. For more information, see Omni-Channel Subscription. name: Omnichannel Subscriptions - description: | The change histories of single version subscriptions. **Note**: To access the change histories, you must turn on the following features: - Orders - Single Version Subscription name: Subscription Change History - description: | A summary journal entry is a summary of Zuora transaction amounts organized by accounting code and general ledger segments. A segment adds more reporting granularity through business dimensions, such as country or product. For more information, see Summary Journal Entries Introduction name: Summary Journal Entries - description: 'The Summary Statement feature provides a comprehensive overview of billing activities for each account using HTML templates that compile data like invoices, credit memos, payments, and more. The associated APIs help automate the creation and management of these statements. See Summary Statements in HTML Templates for more information. ' name: Summary Statements - description: | The TaxationItem object is used to add a tax amount to an invoice item. In the typical use case, the tax amount that you specify in the object is calculated by Z-Tax or a third-party tax engine such as Avalara or Connect tax engine. Changes that you make with this object affect the product charges in your product catalog, but not the charges in existing subscriptions. name: Taxation Items - description: | Consumption of a billable service or resource (such as database storage space or bundles of emails sent) provides the basis for some charge models - simple usage, tiered pricing, or volume pricing. To make this work, usage must be tracked in the system and usage charges must be calculated and invoiced. Usage is always billed in arrears - for example, you might bill customers in February for their January usage. Usage can be billed on a recurring monthly, quarterly, semi-annual, or annual basis. For more information about working with usage data, see Usage. name: Usage - description: | A workflow is a sequence of tasks that are performed based on predefined logic. A workflow improves efficiency and reduces errors by automating a series of complex tasks that otherwise need to be performed manually and repetitively. For more information, see Workflow. name: Workflows - description: | **Note:** You can only use the operations in this section if you have the Billing - Revenue Integration feature enabled. See Billing - Revenue Integration for more information. name: Zuora Revenue Integration paths: /oauth/token: post: description: | Creates a bearer token that enables an OAuth client to authenticate with the Zuora REST API. The OAuth client must have been created using the Zuora UI. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/) for more information. **Note:** When using this operation, do not set any authentication headers such as `Authorization`, `apiAccessKeyId`, or `apiSecretAccessKey`. You should not use this operation to generate a large number of bearer tokens in a short period of time; each token should be used until it expires. If you receive a 429 Too Many Requests response when using this operation, reduce the frequency of requests. This endpoint is rate limited by IP address. For the rate limit information of authentication, see [Rate and concurrent request limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/). operationId: createToken parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/x-www-form-urlencoded: schema: properties: client_id: description: | The Client ID of the OAuth client. maxLength: 36 minLength: 36 type: string client_secret: description: | The Client Secret that was displayed when the OAuth client was created. maxLength: 42 type: string grant_type: description: | The OAuth grant type that will be used to generate the token. The value of this parameter must be `client_credentials`. enum: - client_credentials type: string required: - client_id - client_secret - grant_type type: object required: true responses: '200': content: application/json: examples: response: value: access_token: c652cbc0ea384b9f81856a93a2a74538 expires_in: 3599 jti: c652cbc0ea384b9f81856a93a2a74539 scope: user.7c4d5433dc234c369a01b9719ecd059f entity.1a2b7a37-3e7d-4cb3-b0e2-883de9e766cc entity.c92ed977-510c-4c48-9b51-8d5e848671e9 service.echo.read tenant.19 token_type: bearer schema: $ref: '#/components/schemas/tokenResponse' description: OK headers: X-RateLimit-Limit-minute: description: | The rate limit of this operation, in requests per minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: integer X-RateLimit-Remaining-minute: description: | The number of requests that you may make in the next minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: integer Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '429': description: Too Many Requests headers: X-RateLimit-Limit-minute: description: | The rate limit of this operation, in requests per minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: integer X-RateLimit-Remaining-minute: description: | The number of requests that you may make in the next minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: integer Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Create an OAuth token tags: - OAuth x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=b64e42ba-7e1a-4bc6-9146-5e1b420306b5" --data-urlencode "client_secret=dOFENLWU193EEoEsWjPZrcjLKVr5OrN1HC9Kqg" -d "grant_type=client_credentials" "https://rest.zuora.com/oauth/token" /v1/object/product: post: description: '' operationId: Object_POSTProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateProduct' required: true responses: '200': content: application/json: examples: response: value: Id: 2c93808457d787030157e03246ae5129 Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '400': content: application/json: examples: response: value: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Create a product' tags: - Products /v1/object/product/{id}: get: description: '' operationId: Object_GETProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - description: Object fields to return in: query name: fields required: false schema: type: string - description: Object id in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: CreatedById: 2c93808457d787030157e02e62af2097 CreatedDate: '2016-10-20T05:42:05.000+02:00' Description: Create product via API_new EffectiveEndDate: '2066-10-20' EffectiveStartDate: '1966-10-20' Id: 2c93808457d787030157e02e7be22210 Name: P_1476934925293_new SKU: API-SKU1476934925293 UpdatedById: 2c93808457d787030157e02e62af2097 UpdatedDate: '2016-10-20T05:42:05.000+02:00' schema: $ref: '#/components/schemas/ProxyGetProduct' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '404': content: application/json: examples: response: value: done: true records: {} size: 0 schema: $ref: '#/components/schemas/ProxyNoDataResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Retrieve a product' tags: - Products put: description: '' operationId: Object_PUTProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - description: Object id in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyModifyProduct' required: true responses: '200': content: application/json: examples: response: value: Id: 2c93808457d787030157e02e7be22210 Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Update a product' tags: - Products delete: description: '' operationId: Object_DELETEProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object id in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: id: 2c93808457d787030157e02e7a22220e success: true schema: $ref: '#/components/schemas/ProxyDeleteResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Delete a product' tags: - Products /v1/catalog/products: get: description: | Retrieves the entire product catalog, including all products, features, and their corresponding product rate plans, charges. Products are returned in reverse chronological order on the `UpdatedDate` field. For each product, this operation returns a maximum of 300 product rate plans in the response. Across the returned product rate plans, up to 300 product rate plan charges can be returned for each product. operationId: GET_Catalog parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_catalog' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string responses: '200': content: application/json: examples: response: value: products: - category: Base Products description: '' effectiveEndDate: '2020-01-01' effectiveStartDate: '2017-01-01' id: 8a8082c45aa81b51015ad5a2d07d0e89 name: ABC productNumber: PC-00000011 productRatePlans: https://rest.zuora.com/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan sku: SKU-00000987 success: true schema: $ref: '#/components/schemas/GETCatalogType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all products tags: - Catalog /v1/catalog/products/{product-key}: get: description: | Retrieves detailed information about a specific product, including information about its product rate plans and charges. This operation returns a maximum of 300 product rate plans and 300 product rate plan charges across all product rate plans in the response. operationId: GET_Product parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - description: | The unique ID, SKU, or product number of the product that you want to retrieve. For example, 8a808255575bdae4015774e9602e16fe, SKU-00000987, or PC-00000006. in: path name: product-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: category: Base Products description: '' effectiveEndDate: '2020-01-01' effectiveStartDate: '2017-01-01' id: 8a8082c45aa81b51015ad5a2d07d0e89 name: ABC productNumber: PC-00000006 productRatePlans: https://rest.zuora.com/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan sku: SKU-00000987 success: true schema: $ref: '#/components/schemas/GETProductType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a product tags: - Catalog /v1/catalog-groups: post: description: | **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/). Creates a catalog group which groups a list of product rate plans. operationId: POST_CreateCatalogGroup parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCatalogGroupRequest' required: true responses: '200': content: application/json: examples: response: value: catalogGroupNumber: CG-00000001 description: some description id: 4028e5ab7f1b600c017f1b7a5e8901d2 name: test productRatePlans: - description: null effectiveEndDate: '2023-02-21' effectiveStartDate: '2022-02-21' grade: 1 id: 4028e5ab7f1b600c017f1b787d5d01cf name: '222' status: Active type: Grading schema: $ref: '#/components/schemas/CatalogGroupResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a catalog group tags: - Catalog Groups get: description: | **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/). Retrieves basic information about all catalog groups. operationId: GET_ListAllCatalogGroups parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' responses: '200': content: application/json: examples: response: value: catalogGroups: - catalogGroupNumber: CG-00000001 description: some description id: 4028e5ab7f1b600c017f1b7a5e8901d2 name: test productRatePlans: - description: null effectiveEndDate: '2023-02-21' effectiveStartDate: '2022-02-21' grade: 1 id: 4028e5ab7f1b600c017f1b787d5d01cf name: '222' status: Active type: Grading nextPage: false schema: $ref: '#/components/schemas/ListAllCatalogGroupsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all catalog groups tags: - Catalog Groups /v1/catalog-groups/{catalog-group-key}: get: description: | **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/). Retrieves basic information about a catalog group. operationId: GET_RetrieveCatalogGroup parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the catalog group to be retrieved. in: path name: catalog-group-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: catalogGroupNumber: CG-00000001 description: some description id: 4028e5ab7f1b600c017f1b7a5e8901d2 name: test productRatePlans: - description: null effectiveEndDate: '2023-02-21' effectiveStartDate: '2022-02-21' grade: 1 id: 4028e5ab7f1b600c017f1b787d5d01cf name: '222' status: Active type: Grading schema: $ref: '#/components/schemas/CatalogGroupResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a catalog group tags: - Catalog Groups put: description: | **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/). Updates a catalog group by its unique number or ID. ### Notes - It is best practice to only specify the fields that you want to change in the request body. - If you specify an empty value for a field in the request body, the corresponding field in the catalog group is emptied. - The catalog group type cannot be changed. operationId: PUT_UpdateCatalogGroup parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the catalog group to be updated. in: path name: catalog-group-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTCatalogGroup' required: true responses: '200': content: application/json: examples: response: value: catalogGroupNumber: CG-00000001 description: some description id: 4028e5ab7f1b600c017f1b7a5e8901d2 name: test productRatePlans: - description: null effectiveEndDate: '2023-02-21' effectiveStartDate: '2022-02-21' grade: 1 id: 4028e5ab7f1b600c017f1b787d5d01cf name: '222' status: Active type: Grading schema: $ref: '#/components/schemas/CatalogGroupResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a catalog group tags: - Catalog Groups delete: description: | **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/). Deletes a catalog group. operationId: DELETE_CatalogGroup parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the catalog group to be deleted. in: path name: catalog-group-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: 'true' schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a catalog group tags: - Catalog Groups /v1/products/{product-key}/product-rate-plans: get: description: | Retrieves information about all product rate plans of a specific product. operationId: GET_ProductRatePlans parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or SKU of a product. For example, 2c92c0f96487e16a016487f663c71a61 or SKU-00000987. in: path name: product-key required: true schema: type: string - description: | Specifies whether to include the product charge definitions of this rate plan in the response. **Note**: This parameter is applicable only if the Attribute Based Pricing feature is enabled. To access this feature, submit a request at Zuora Global Support. in: query name: show-charge-definitions required: false schema: type: boolean responses: '200': content: application/json: examples: response: value: productRatePlans: - description: '' effectiveEndDate: '2020-07-31' effectiveStartDate: '2016-07-01' grade: 3 id: 40289f466464127601646473d6f7000f name: New Rate Plan productRatePlanCharges: - applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE defaultQuantity: null description: '' discountClass: null discountLevel: null endDateCondition: Subscription_End financeInformation: deferredRevenueAccountingCode: '' deferredRevenueAccountingCodeType: null recognizedRevenueAccountingCode: '' recognizedRevenueAccountingCodeType: null id: 40289f4664641276016464740dd0001c listPriceBase: Per_Billing_Period model: FlatFee name: New Component numberOfPeriods: null overageCalculationOption: null overageUnusedUnitsCreditOption: null priceChangeOption: null priceIncreasePercentage: null pricing: - currency: USD discountAmount: null discountPercentage: null includedUnits: null overagePrice: null price: 100 tiers: null pricingSummary: - USD100 productChargeDefinitions: https://rest.zuora.com/v1/product-charge-definitions?charge=8a80808e8aaf3b0a018aaf3f2beb022b&rateplan=8a80808e8aaf3b0a018aaf3ed4cf021e productDiscountApplyDetails: [] productRatePlanChargeNumber: PRPC-00000001 revRecCode: '' revRecTriggerCondition: ContractEffectiveDate revenueRecognitionRuleName: Recognize upon invoicing smoothingModel: null specificBillingPeriod: null specificListPriceBase: null taxCode: '' taxMode: null taxable: false triggerEvent: ContractEffective type: Recurring unusedIncludedUnitPrice: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null useDiscountSpecificAccountingCode: null useTenantDefaultForPriceChange: null productRatePlanNumber: PRP-00000001 status: Active success: true schema: $ref: '#/components/schemas/GETProductRatePlansResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all product rate plans of a product tags: - Product Rate Plans /v1/product-rate-plans/{id}: get: description: | Retrieves a product rate plan by its ID. operationId: GET_ProductRatePlan parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID, external ID, or the natural key of the product rate plan to be retrieved. For example, `402888e67f8b3a68017f8bbb2a06062d`, `Apple0001`, or `PRP-00000008`. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: description: '' effectiveEndDate: '2032-02-01' effectiveStartDate: '2012-02-01' externalIdSourceSystem: apple externallyManagedPlanIds: - Apple0001 - Apple0002 - Google0003 grade: 3 id: 402888e67f8b3a68017f8bbb2a06062d name: New Rate Plan Change productRatePlanNumber: PRP-00000008 status: Active success: true schema: $ref: '#/components/schemas/GETProductRatePlanWithExternalIdResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a product rate plan by ID tags: - Product Rate Plans /v1/product-rate-plans/external-id/{id}: get: description: | Retrieves information about one or multiple product rate plans by external ID. operationId: GET_ProductRatePlansByExternalID parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The external ID of the product rate plan to be retrieved. For example, `Apple0001`. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: - description: '' effectiveEndDate: '2023-01-01' effectiveStartDate: '2022-01-01' externalIdSourceSystem: apple externallyManagedPlanIds: - a id: 2c989020823f450c01823fef40421eb6 name: My rate plan 072706 status: Active - description: '' effectiveEndDate: '2023-01-01' effectiveStartDate: '2022-01-01' externalIdSourceSystem: apple externallyManagedPlanIds: - a id: 2c989020823f450c01823fede57d1eb5 name: My rate plan 072705 status: Active schema: $ref: '#/components/schemas/GETProductRatePlanWithExternalIdMultiResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List product rate plans by external ID tags: - Product Rate Plans /v1/object/product-rate-plan: post: description: | Retrieves a product rate plan. operationId: Object_POSTProductRatePlan parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateProductRatePlan' required: true responses: '200': content: application/json: examples: response: value: Id: 2c93808457d787030157e0324735512b Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '400': content: application/json: examples: response: value: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Create a product rate plan' tags: - Product Rate Plans /v1/object/product-rate-plan/{id}: get: description: | Retrieves a product rate plan. operationId: Object_GETProductRatePlan parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - description: Object fields to return in: query name: fields required: false schema: type: string - description: Object id in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: CreatedById: 2c93808457d787030157e02d84c116d5 CreatedDate: '2016-10-20T05:41:09.000+02:00' Description: Test create product rateplan via API EffectiveEndDate: '2066-10-20' EffectiveStartDate: '1966-10-20' Grade: 3 Id: 2c93808457d787030157e02da0d91852 Name: ProductRatePlan1476934869186_new ProductId: 2c93808457d787030157e02da0231850 UpdatedById: 2c93808457d787030157e02d84c116d5 UpdatedDate: '2016-10-20T05:41:09.000+02:00' schema: $ref: '#/components/schemas/ProxyGetProductRatePlan' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '404': content: application/json: examples: response: value: done: true records: {} size: 0 schema: $ref: '#/components/schemas/ProxyNoDataResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Retrieve a product rate plan' tags: - Product Rate Plans put: description: | Updates a product rate plan. operationId: Object_PUTProductRatePlan parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - description: Object id in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyModifyProductRatePlan' required: true responses: '200': content: application/json: examples: response: value: Id: 2c93808457d787030157e02da0d91852 Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Update a product rate plan' tags: - Product Rate Plans delete: description: | Deletes a product rate plan. operationId: Object_DELETEProductRatePlan parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object id in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: id: 2c93808457d787030157e02d9dde184f success: true schema: $ref: '#/components/schemas/ProxyDeleteResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Delete a product rate plan' tags: - Product Rate Plans /v1/product-rateplan-definitions: post: description: | Creates a product rate plan definition to use a charge in a product rate plan. In the request, you must specify either the unique ID or number of both the charge and the product rate plan to add the specified charge to a specific rate plan. **Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. operationId: POST_CreateProductRatePlanDefinition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTRatePlanDefinitionRequest' required: true responses: '200': content: application/json: examples: response: value: id: 2c9890f78aba5c16018ababa00120019 success: true schema: $ref: '#/components/schemas/POSTRatePlanDefinitionResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a product rate plan definition tags: - Product Rate Plan Definitions get: description: | Retrieves basic information about the product rate plan definitions for a product rate plan. **Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. operationId: GET_RetrieveProductRatePlanDefinitions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique number or ID of the charge for which the product rate plan definitions are to be retrieved. in: query name: charge required: false schema: type: string - description: | The unique number or ID of the product rate plan for which the product rate plan definitions are to be retrieved. in: query name: rateplan required: false schema: type: string responses: '200': content: application/json: examples: response: value: productRatePlanDefinitions: - id: 2c9890f78b212d76018b218993c9005c productRatePlanChargeId: 2c9890f78aba5c16018ababa00120019 productRatePlanChargeName: New Component productRatePlanChargeNumber: PRPC-NEW-00000175 productRatePlanId: 2c9890678b1ca909018b1caea5c30000 productRatePlanName: New Rate Plan2 productRatePlanNumber: PRP-NEW-00000353 - id: 2c9890f78b212d76018b21742683005a productRatePlanChargeId: 2c9890f78b212d76018b2174263c004a productRatePlanChargeName: API_Usage_Tiered-multi productRatePlanChargeNumber: PRPC-NEW-00000246 productRatePlanId: 2c9890678b1ca909018b1caea5c30000 productRatePlanName: New Rate Plan2 productRatePlanNumber: PRP-NEW-00000353 success: true schema: $ref: '#/components/schemas/GETProductRatePlanDefinitionsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List product rate plan definitions tags: - Product Rate Plan Definitions /v1/product-rateplan-definitions/{product-rateplan-definition-key}: get: description: | Retrieves basic information about a product rate plan definition. **Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. operationId: GET_RetrieveProductRatePlanDefinition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique ID of the product rate plan definition to be retrieved. in: path name: product-rateplan-definition-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: id: 2c9890f78b212d76018b21937228005d productRatePlanChargeId: 2c9890e489f227bd0189f22f3482001f productRatePlanChargeName: Per Unit productRatePlanChargeNumber: null productRatePlanId: 2c9890678b1ca909018b1caea5c30000 productRatePlanName: New Rate Plan2 productRatePlanNumber: PRP-NEW-00000353 success: true schema: $ref: '#/components/schemas/GETProductRatePlanDefinitionResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a product rate plan definition tags: - Product Rate Plan Definitions delete: description: | Deletes a product rate plan definition. **Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. operationId: DELETE_ProductRatePlanDefnition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique ID of the product rate plan definition to be deleted. in: path name: product-rateplan-definition-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a product rate plan definition tags: - Product Rate Plan Definitions /v1/product-rate-plan-charges/{product-rate-plan-charge-key}: get: description: | Retrieves basic information about a product rate plan charge. operationId: GET_RetrieveProductRatePlanCharge parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique number or ID of the product rate plan charge to be retrieved. in: path name: product-rate-plan-charge-key required: true schema: type: string - description: | Specifies whether to include the product charge definitions of this charge in the response. **Note**: This parameter is applicable only if the Attribute-based Pricing feature is enabled. The Attribute-based Pricing feature in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters. If you are interested, please reach out to your CSM. in: query name: show-charge-definitions required: false schema: type: boolean responses: '200': content: application/json: examples: response: value: id: edca018c566983fa11f6d38381b10000 name: Attribute based pricing charge with formula type: Recurring model: FlatFee uom: null pricingSummary: - USD60 pricing: - currency: USD price: 60 tiers: null includedUnits: null overagePrice: null discountPercentage: null discountAmount: null defaultQuantity: null applyDiscountTo: null discountLevel: null discountClass: null applyToBillingPeriodPartially: false productDiscountApplyDetails: [] endDateCondition: Subscription_End upToPeriods: null upToPeriodsType: null billingDay: DefaultFromCustomer listPriceBase: Per_Billing_Period specificListPriceBase: null billingTiming: IN_ADVANCE ratingGroup: null billingPeriod: Month billingPeriodAlignment: AlignToCharge specificBillingPeriod: null smoothingModel: null numberOfPeriods: null overageCalculationOption: null overageUnusedUnitsCreditOption: null unusedIncludedUnitPrice: null usageRecordRatingOption: null priceChangeOption: null priceIncreasePercentage: null useTenantDefaultForPriceChange: true taxable: false taxCode: '' taxMode: null isPrepaid: false prepaidOperationType: null prepaidUom: null prepaidQuantity: null prepaidTotalQuantity: null validityPeriodType: SUBSCRIPTION_TERM drawdownRate: null drawdownUom: null creditOption: TimeBased isRollover: false rolloverPeriods: 0 rolloverPeriodLength: 0 rolloverApply: ApplyLast triggerEvent: ContractEffective description: '' revRecCode: null revRecTriggerCondition: null revenueRecognitionRuleName: Recognize upon invoicing useDiscountSpecificAccountingCode: null excludeItemBookingFromRevenueAccounting: false excludeItemBillingFromRevenueAccounting: false financeInformation: deferredRevenueAccountingCode: '' deferredRevenueAccountingCodeType: null recognizedRevenueAccountingCode: '' recognizedRevenueAccountingCodeType: null accountsReceivableAccountingCode: Accounts Receivable accountsReceivableAccountingCodeType: AccountsReceivable contractAssetAccountingCode: null contractAssetAccountingCodeType: null contractLiabilityAccountingCode: null contractLiabilityAccountingCodeType: null adjustmentLiabilityAccountingCode: null adjustmentLiabilityAccountingCodeType: null unbilledReceivablesAccountingCode: null unbilledReceivablesAccountingCodeType: null adjustmentRevenueAccountingCode: null adjustmentRevenueAccountingCodeType: null contractRecognizedRevenueAccountingCode: null contractRecognizedRevenueAccountingCodeType: null deliverySchedule: null isStackedDiscount: false productRatePlanChargeNumber: null formula: lookup("soldToRegion__c" = fieldLookup("subscription", "soldToRegion__c")) productChargeDefinitions: https://rest-staging2.zuora.com/apps/v1/product-charge-definitions?charge=edca018c566983fa11f6d38381b10000 success: true schema: $ref: '#/components/schemas/GETProductRatePlanChargeResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Retrieve a product rate plan charge tags: - Product Rate Plan Charges /v1/object/product-rate-plan-charge: post: description: | Creates a product rate plan charge for a specified rate plan charge. Product rate plan charges can be of three types, one-time fees, recurring fees, and usage fees. operationId: Object_POSTProductRatePlanCharge parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateProductRatePlanCharge' required: true responses: '200': content: application/json: examples: response: value: Id: 2c93808457d787030157e03197714910 Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Create a product rate plan charge' tags: - Product Rate Plan Charges /v1/object/product-rate-plan-charge/{id}: get: description: '' operationId: Object_GETProductRatePlanCharge parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - description: Object fields to return in: query name: fields required: false schema: type: string - description: | The unique ID of a product rate plan charge to be retrieved. For example, 2c93808457d787030157e031fcd34e19. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: AccountingCode: name_1476935155610 BillCycleDay: 1 BillCycleType: DefaultFromCustomer BillingPeriod: Month BillingPeriodAlignment: AlignToCharge BillingTiming: In Advance ChargeModel: Flat Fee Pricing ChargeType: Recurring CreatedById: 2c93808457d787030157e031dd264c85 CreatedDate: '2016-10-20T05:45:55.000+02:00' DefaultQuantity: 1 DeferredRevenueAccount: name_1476935155610 Description: Recurring Flat Fee Pricing EndDateCondition: SubscriptionEnd Id: 2c93808457d787030157e032002b4e21 IncludedUnits: 0 LegacyRevenueReporting: false ListPriceBase: Per Billing Period Name: Recurring_Flat Fee Pricing1476935155610 NumberOfPeriod: 1 OverageCalculationOption: EndOfSmoothingPeriod OverageUnusedUnitsCreditOption: NoCredit PriceChangeOption: NoChange PriceIncreasePercentage: 0 ProductRatePlanId: 2c93808457d787030157e031ff054e1e RecognizedRevenueAccount: name_1476935155610 RevenueRecognitionRuleName: Recognize upon invoicing Taxable: false TriggerEvent: ContractEffective UpToPeriodsType: Billing Periods UpdatedById: 2c93808457d787030157e031dd264c85 UpdatedDate: '2016-10-20T05:45:55.000+02:00' UseTenantDefaultForPriceChange: true Formula: '' schema: $ref: '#/components/schemas/ProxyGetProductRatePlanCharge' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '404': content: application/json: examples: response: value: done: true records: {} size: 0 schema: $ref: '#/components/schemas/ProxyNoDataResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Retrieve a product rate plan charge' tags: - Product Rate Plan Charges put: description: | Updates the information about a product rate plan charge. operationId: Object_PUTProductRatePlanCharge parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - description: | The unique ID of the product rate plan charge to be updated. For example, 2c93808457d787030157e031fcd34e19. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyModifyProductRatePlanCharge' required: true responses: '200': content: application/json: examples: response: value: Id: 2c93808457d787030157e03197714910 Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '404': content: application/json: examples: response: value: done: true records: {} size: 0 schema: $ref: '#/components/schemas/ProxyNoDataResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Update a product rate plan charge' tags: - Product Rate Plan Charges delete: description: | Deletes a product rate plan charge. operationId: Object_DELETEProductRatePlanCharge parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The unique ID of the product rate plan charge to be deleted. For example, 2c93808457d787030157e031fcd34e19. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: id: 2c93808457d787030157e031fcd34e19 success: true schema: $ref: '#/components/schemas/ProxyDeleteResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Delete a product rate plan charge' tags: - Product Rate Plan Charges /v1/product-charge-definitions: post: description: | Creates a product charge definition for a charge. You can create as many product charge definitions as needed for one charge. In the request, you must specify the unique ID or number of the charge for which this charge definition is to be created. The ID or number of a product rate plan is optional. **Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. operationId: POST_CreateProductChargeDefinition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTChargeDefinitionRequest' required: true responses: '200': content: application/json: examples: response: value: chargeDefinitionId: 8a90988c8b177a24018b17857411002a chargeDefinitionNumber: CD-00002089 success: true schema: $ref: '#/components/schemas/POSTChargeDefinitionResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a product charge definition tags: - Product Charge Definitions get: description: | Retrieves basic information about the product charge definitions. **Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. operationId: GET_RetrieveProductChargeDefinitions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique number or ID of the charge for which the product charge definitions are to be retrieved. in: query name: charge required: false schema: type: string - description: | The unique number or ID of the product rate plan for which the product charge definitions are to be retrieved. in: query name: rateplan required: false schema: type: string - description: | The flag that controls whether the response will merge the default charge definition fields for those fields that are not overridden. in: query name: hide-inherited-values required: false schema: type: boolean responses: '200': content: application/json: examples: response: value: chargeDefinitions: - applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargeModel: FlatFee defaultQuantity: 1 deliverySchedule: null description: '' discountClass: null discountLevel: null effectiveEndDate: '2023-10-13 09:00:00' effectiveStartDate: '2022-10-07 09:00:00' endDateCondition: Subscription_End financeInformation: accountsReceivableAccountingCode: null accountsReceivableAccountingCodeType: null deferredRevenueAccountingCode: '' deferredRevenueAccountingCodeType: null recognizedRevenueAccountingCode: '' recognizedRevenueAccountingCodeType: null isDefault: true isStackedDiscount: false listPriceBase: Per_Billing_Period numberOfPeriods: null overageCalculationOption: null overageUnusedUnitsCreditOption: null priceChangeOption: null priceIncreasePercentage: null prices: - currency: EUR price: 10 - currency: JPY price: 20 - currency: USD price: 25 productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004 productChargeDefinitionNumber: CD-00000201 productDiscountApplyDetails: [] productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004 productRatePlanChargeNumber: null productRatePlanId: null productRatePlanName: null productRatePlanNumber: null ratingGroup: null revRecCode: null revRecTriggerCondition: null revenueRecognitionRuleName: Recognize upon invoicing smoothingModel: null specificBillingPeriod: null specificListPriceBase: null taxCode: '' taxMode: null taxable: false term: null termPeriodType: null termType: null triggerEvent: ContractEffective uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null useDiscountSpecificAccountingCode: null useTenantDefaultForPriceChange: true success: true schema: $ref: '#/components/schemas/GETProductChargeDefinitionsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List product charge definitions tags: - Product Charge Definitions /v1/product-charge-definitions/bulk: post: description: | Bulk creates product charge definitions for a charge. You can create up to 1000 product charge definitions at a given time for a specific charge. In the request, you must specify the unique ID or number of the charge for which this charge definition is to be created. The ID or number of a product rate plan is optional. **Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. operationId: POST_CreateProductChargeDefinitionBulk parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTChargeDefinitionRequestBulk' required: true responses: '200': content: application/json: examples: response: value: summary: successCount: 1 failureCount: 1 failures: - 1 results: - chargeDefinitionId: test8a90988c8b177a24018b17857411002a chargeDefinitionNumber: CD-00002089 success: true - success: false processId: 5538FC6A344124EF reasons: - code: '400' message: Charge definitions in this payload have overlapping effective periods without differentiating attributes. success: true schema: $ref: '#/components/schemas/POSTChargeDefinitionBulkResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create product charge definitions tags: - Product Charge Definitions put: description: | Bulk updates multiple product charge definitions. **Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. operationId: PUT_UpdateProductChargeDefinitionBulk parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTProductChargeDefinitionBulkRequest' required: true responses: '200': content: application/json: examples: response: value: chargeDefinitions: - applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargeModel: FlatFee defaultQuantity: 1 deliverySchedule: null description: '' discountClass: null discountLevel: null endDateCondition: Subscription_End financeInformation: accountsReceivableAccountingCode: null accountsReceivableAccountingCodeType: null deferredRevenueAccountingCode: '' deferredRevenueAccountingCodeType: null recognizedRevenueAccountingCode: '' recognizedRevenueAccountingCodeType: null isDefault: true isStackedDiscount: false listPriceBase: Per_Billing_Period numberOfPeriods: null overageCalculationOption: null overageUnusedUnitsCreditOption: null priceChangeOption: null priceIncreasePercentage: null prices: - currency: EUR price: 10 - currency: JPY price: 20 - currency: USD price: 25 productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004 productChargeDefinitionNumber: CD-00000201 productDiscountApplyDetails: [] productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004 productRatePlanChargeNumber: null productRatePlanId: null productRatePlanName: null productRatePlanNumber: null ratingGroup: null revRecCode: null revRecTriggerCondition: null revenueRecognitionRuleName: Recognize upon invoicing smoothingModel: null specificBillingPeriod: null specificListPriceBase: null taxCode: '' taxMode: null taxable: false term: null termPeriodType: null termType: null triggerEvent: ContractEffective uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null useDiscountSpecificAccountingCode: null useTenantDefaultForPriceChange: true success: true schema: $ref: '#/components/schemas/GETProductChargeDefinitionsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update product charge definitions tags: - Product Charge Definitions /v1/product-charge-definitions/{product-charge-definition-key}: get: description: | Retrieves basic information about a product charge definition. **Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. operationId: GET_RetrieveProductChargeDefinition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique number or ID of the product charge definition to be retrieved. in: path name: product-charge-definition-key required: true schema: type: string - description: | The flag that controls whether the response will merge the default charge definition fields for those fields that are not overridden. in: query name: hide-inherited-values required: false schema: type: boolean responses: '200': content: application/json: examples: response: value: applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargeModel: FlatFee defaultQuantity: 1 deliverySchedule: null description: '' discountClass: null discountLevel: null effectiveEndDate: '2023-10-13 09:00:00' effectiveStartDate: '2022-10-07 09:00:00' endDateCondition: Subscription_End financeInformation: accountsReceivableAccountingCode: null accountsReceivableAccountingCodeType: null deferredRevenueAccountingCode: '' deferredRevenueAccountingCodeType: null recognizedRevenueAccountingCode: '' recognizedRevenueAccountingCodeType: null isDefault: true isStackedDiscount: false listPriceBase: Per_Billing_Period numberOfPeriods: null overageCalculationOption: null overageUnusedUnitsCreditOption: null priceChangeOption: null priceIncreasePercentage: null prices: - currency: EUR price: 10 - currency: JPY price: 20 - currency: USD price: 25 productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004 productChargeDefinitionNumber: CD-00000201 productDiscountApplyDetails: [] productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004 productRatePlanChargeNumber: null productRatePlanId: null productRatePlanName: null productRatePlanNumber: null ratingGroup: null revRecCode: null revRecTriggerCondition: null revenueRecognitionRuleName: Recognize upon invoicing smoothingModel: null specificBillingPeriod: null specificListPriceBase: null success: true taxCode: '' taxMode: null taxable: false term: null termPeriodType: null termType: null triggerEvent: ContractEffective uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null useDiscountSpecificAccountingCode: null useTenantDefaultForPriceChange: true schema: $ref: '#/components/schemas/GETProductChargeDefinitionResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a product charge definition tags: - Product Charge Definitions put: description: | Update a product charge definition. **Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. operationId: PUT_UpdateProductChargeDefinition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique number or ID of the product charge definition to be updated. in: path name: product-charge-definition-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTProductChargeDefinitionRequest' required: true responses: '200': content: application/json: examples: response: value: applyDiscountTo: null billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargeModel: FlatFee defaultQuantity: 1 discountClass: null discountLevel: null effectiveEndDate: '2023-10-13 09:00:00' effectiveStartDate: '2022-10-07 09:00:00' isDefault: true listPriceBase: Per_Billing_Period numberOfPeriods: null prices: - currency: USD price: 10 productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004 productChargeDefinitionNumber: CD-00000201 productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004 productRatePlanChargeNumber: null productRatePlanId: null productRatePlanName: null productRatePlanNumber: null ratingGroup: null smoothingModel: null specificBillingPeriod: null specificListPriceBase: null success: true taxCode: '' taxMode: null taxable: false term: null termPeriodType: null termType: null uom: null schema: $ref: '#/components/schemas/GETProductChargeDefinitionResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a product charge definition tags: - Product Charge Definitions delete: description: | Deletes a product charge definition. **Note**: This operation requires the [Attribute-based Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing) feature to be enabled, which is in the **Early Adopter** phase. operationId: DELETE_ProductChargeDefnition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique number or ID of the product charge definition to be deleted. in: path name: product-charge-definition-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a product charge definition tags: - Product Charge Definitions /v1/object/product-rate-plan-charge-tier/{id}: get: description: '' operationId: Object_GETProductRatePlanChargeTier parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object fields to return in: query name: fields required: false schema: type: string - description: Object id in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: CreatedById: 2c93808457d787030157e02fd0f132a4 CreatedDate: '2016-10-20T05:43:38.000+02:00' Currency: USD EndingUnit: 0 Id: 2c93808457d787030157e02fe725341f Price: 30 PriceFormat: Flat Fee StartingUnit: 0 Tier: 1 UpdatedById: 2c93808457d787030157e02fd0f132a4 UpdatedDate: '2016-10-20T05:43:38.000+02:00' schema: $ref: '#/components/schemas/ProxyGetProductRatePlanChargeTier' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '404': content: application/json: examples: response: value: done: true records: {} size: 0 schema: $ref: '#/components/schemas/ProxyNoDataResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Retrieve a product rate plan charge tier' tags: - Product Rate Plan Charge Tiers put: description: | Updates the price of a product rate plan charge tier. To make other updates to product rate plan charge tiers, use [CRUD: Update a product rate plan charge](https://developer.zuora.com/api-references/api/operation/Object_PUTProductRatePlanCharge) and specify `ProductRatePlanChargeTierData` in the request body. operationId: Object_PUTProductRatePlanChargeTier parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The unique ID of the product rate plan charge tier to be updated. For example, 2c92c0f86c85891e016c88d55a6e543b. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyModifyProductRatePlanChargeTier' required: true responses: '200': content: application/json: examples: response: value: Id: 2c92c0f86c85891e016c88d55a6e543b Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Update a product rate plan charge tier' tags: - Product Rate Plan Charge Tiers /v1/revpro-accounting-codes: put: description: Update the Zuora Revenue accounting code that corresponds to a specific Product Rate Plan Charge Id in Zuora Billing. operationId: PUT_RevProAccountingCodes parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/RevproAccountingCodes' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/PUTRevproAccCodeResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a Zuora Revenue accounting code tags: - Zuora Revenue Integration /v1/accounts: post: description: | Creates a customer account with a payment method, a bill-to contact, and an optional sold-to contact. Request and response field descriptions and sample code are provided. Use this operation to optionally create a subscription, invoice for that subscription, and collect payment through the default payment method. The transaction is atomic; if any part fails for any reason, the entire transaction is rolled back. This operation is CORS Enabled, so you can use client-side Javascript to invoke the call. ### Notes 1. The account is created in active status. 2. If the `autoPay` field is set to `true` in the request, you must provide one of the `paymentMethod`, `creditCard`, or `hpmCreditCardPaymentMethodId` field, but not multiple. The one provided becomes the default payment method for this account. If the credit card information is declined or cannot be verified, no account is created. 3. Customer accounts created with this call are automatically be set to Auto Pay. 4. If the `invoiceDeliveryPrefsEmail` field is not specified in the request, the account's email delivery preference is always automatically set to `false`, no matter whether the `workEmail` or `personalEmail` field is specified. ### Defaults for customerAcceptanceDate and serviceActivationDate Default values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows. | | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified | | ------------- |:-------------:| -----:| | customerAcceptanceDate (CA) specified | SA uses value in the request call; CA uses value in the request call| CA uses value in the request call;SA uses CE as default | | customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default | operationId: POST_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTAccountType' required: true responses: '200': content: application/json: examples: response: value: success: true accountId: 8ad087d2909293cb0190964171da0999 accountNumber: A00000214 billToContactId: 8ad087d2909293cb019096417222099b soldToContactId: 8ad087d2909293cb01909641723e099e schema: $ref: '#/components/schemas/POSTAccountResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create an account tags: - Accounts /v1/accounts/{account-key}: delete: description: | Deletes a specific account asynchronously. **Notes and Limitations:** - For account deletion, the system will start a backend job to remove all transactions under the accounts and change the status of the accounts to 'Cancelled'. This backend job is asynchronous and will take some time, depending on the job size. - An account cannot be deleted when the account is either the invoice owner or the subscription owner of a subscription and the subscription's invoice owner and subscription owner are two different accounts. An exception to this limitation is if the Enable Force Deletion for Account? setting is set to `Yes`, you can force delete an account that is the subscription owner of a subscription while the invoice owner is a different account. Force deleting this account deletes all its subscriptions, but the relevant invoices will not be impacted. - An account cannot be deleted if this account has ever been involved in an Owner Transfer amendment or order action, either as the current owner or as the previous owner. operationId: DELETE_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: id: 40288ae9600808280160081dc9c13f15 jobId: 40288ae9600808280160081db1533506 jobStatus: Pending success: true schema: $ref: '#/components/schemas/DeleteAccountResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete an account tags: - Accounts get: description: | Retrieves basic information about a customer account. This operation is a quick retrieval that doesn't include the account's subscriptions, invoices, payments, or usage details. Use Get account summary to get more detailed information about an account. operationId: GET_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: basicInfo: accountNumber: A00000001 batch: Batch1 communicationProfileId: 303d186840e611df817c002185d714e1 crmId: '' id: 402892c74c9193cd014c91d35b0a0132 invoiceTemplateId: null name: Test notes: '' partnerAccount: false profileNumber: CP-00000012 salesRep: '' sequenceSetId: null status: Active summaryStatementTemplateId: ff808081298c6e5401298c7a845c007b billToContact: address1: '' address2: '' city: '' country: null county: null fax: '' firstName: Test homePhone: '' id: 2c9081a03c6d7b51013c6d7e46c80a17 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' billingAndPayment: additionalEmailAddresses: - contact1@example.com - contact2@example.com autoPay: true billCycleDay: 1 currency: USD defaultPaymentMethodId: 2c93808457d787030157e03220ec4fad invoiceDeliveryPrefsEmail: true invoiceDeliveryPrefsPrint: false paymentMethodCascadingConsent: false paymentGateway: TestGateway paymentTerm: Net 30 einvoiceProfile: businessCategory: B2B businessName: legal business name businessNumber: '20002039' businessNumberSchemeId: '88' enabled: true endpointId: '8992' endpointSchemeId: '88' taxRegisterNumber: TAX393999 metrics: balance: 0 contractedMrr: -900 creditBalance: 0 totalInvoiceBalance: 0 metricsData: - balance: 0 contractedMrr: -900 currency: USD reservedPaymentAmount: 900 totalDebitMemoBalance: 0 totalInvoiceBalance: 0 unappliedCreditMemoAmount: 0 unappliedPaymentAmount: 0 - balance: 0 contractedMrr: -900 currency: EUR reservedPaymentAmount: -900 totalDebitMemoBalance: 0 totalInvoiceBalance: 0 unappliedCreditMemoAmount: 0 unappliedPaymentAmount: 0 soldToContact: address1: '' address2: '' city: '' country: null county: null fax: '' firstName: Test homePhone: '' id: 2c9081a03c6d7b51013c6d7e46cf0a18 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' success: true schema: $ref: '#/components/schemas/GETAccountType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve an account tags: - Accounts put: description: | Updates a customer account by specifying the account-key. ### Notes 1. Only the fields to be changed should be specified. Any field that is not included in the request body will not be changed. 2. If an empty field is submitted with this operation, the corresponding field in the account is emptied. 3. Email addresses: If no email addresses are specified, no change is made to the email addresses or to the email delivery preference. If either the **personalEmail** or **workEmail** of **billToContact** is specified (or both), the system updates the corresponding email address(es) and the email delivery preference is set to `true`. (In that case, emails go to the **workEmail** address, if it exists, or else the **personalEmail**.) On the other hand, if as a result of this call both of the email addresses for the account are empty, the email delivery preference is set to `false`. 4. The bill-to and sold-to contacts are separate data entities. If you select the **Same as Bill To Contact** check box during account creation, both the Bill To and Sold To contacts are updated upon updating either one because they point to the same contact record. In this case, if you want to update only one of them, you have to first create another contact and update the Bill To or Sold To contact of the customer account to be the newly created one. operationId: PUT_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTAccountType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update an account tags: - Accounts /v1/accounts/{account-key}/payment-methods: get: description: | Retrieves the payment methods of the specified customer account. **Note:** This operation also supports retrieving custom payment methods created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service. operationId: GET_AcountPaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string - description: Indicates whether to only retrieve the default payment method of the account. The default value is `false`. If this parameter is set to `true`, only the default payment method is retrieved. in: query name: isDefaultOnly required: false schema: type: boolean - description: Indicates whether to only retrieve the active payment methods of the account. The default value is `false`. If this parameter is set to `true`, only the active payment methods are retrieved. in: query name: isActiveOnly required: false schema: type: boolean responses: '200': content: application/json: examples: response: value: ach: - AA_PICKLIST__c: null accountHolderInfo: accountHolderName: null addressLine1: DSDFD addressLine2: '' city: Example City country: United States email: test@test.com phone: '2554444' state: Example State zipCode: '123456' accountKey: 4028839f7ca29000017ca29c1ce8003f bankABACode: '110000000' bankAccountName: Test bankAccountNumber: '********6789' bankAccountType: Checking bankIdentificationNumber: null bankName: Chase createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-10-27 05:32:19' deviceSessionId: null existingMandate: null id: 4028839f7cc14262017cc1bca9eb0008 ipAddress: null isDefault: false lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-10-27 05:32:19' lastTransactionStatus: Approved mandateInfo: existingMandateStatus: null mandateCreationDate: null mandateId: null mandateReason: null mandateReceivedStatus: null mandateStatus: null mandateUpdateDate: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null status: Active totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: ACH updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-10 00:50:12' useDefaultRetryRule: true creditcard: - AA_PICKLIST__c: null accountHolderInfo: accountHolderName: John Smith addressLine1: ABC addressLine2: EFT city: Example City country: United States email: example@google.com phone: '86123456789' state: Example State zipCode: '123456' accountKey: 4028839f7ca29000017ca29c1ce8003f bankIdentificationNumber: '411111' cardNumber: '************1111' createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-11-15 18:59:08' creditCardType: Visa deviceSessionId: null existingMandate: null expirationMonth: 11 expirationYear: 2027 id: 4028839f7d26a155017d26af16ef0001 identityNumber: '97370192024' ipAddress: null isDefault: true lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-11-15 18:59:08' lastTransactionStatus: Approved mandateInfo: mitConsentAgreementRef: null mitConsentAgreementSrc: null mitProfileAction: null mitProfileAgreedOn: null mitProfileType: null mitTransactionId: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null status: Active totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: CreditCard updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-15 18:59:08' useDefaultRetryRule: true creditcardreferencetransaction: - AA_PICKLIST__c: null accountHolderInfo: accountHolderName: '' addressLine1: '' addressLine2: '' city: '' country: null email: '' phone: null state: '' zipCode: '' accountKey: 4028839f7ca29000017ca29c1ce8003f bankIdentificationNumber: null cardNumber: null createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-11-03 22:35:59' creditCardType: Visa deviceSessionId: null existingMandate: null expirationMonth: 11 expirationYear: 2021 id: 4028839f7ce8c530017ce9725e2c0003 ipAddress: null isDefault: false lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-11-03 22:35:59' lastTransactionStatus: Approved mandateInfo: mitConsentAgreementRef: null mitConsentAgreementSrc: null mitProfileAction: null mitProfileAgreedOn: null mitProfileType: null mitTransactionId: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null secondTokenId: FGDSDF status: Active tokenId: ABCE totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: CreditCardReferenceTransaction updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-03 22:35:59' useDefaultRetryRule: true debitcard: - AA_PICKLIST__c: null accountHolderInfo: accountHolderName: John Smith addressLine1: 1051 E Hillsdale Blvd addressLine2: '' city: Tynan country: United States email: smith@example.com phone: '' state: California zipCode: '45101' accountKey: 4028839f7ca29000017ca29c1ce8003f bankIdentificationNumber: '588888' cardNumber: '************8888' createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-11-01 00:01:52' creditCardType: Electron deviceSessionId: null existingMandate: null expirationMonth: 11 expirationYear: 2021 id: 4028839f7cd92a6b017cda4defd00006 ipAddress: null isDefault: false lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-11-01 00:01:53' lastTransactionStatus: Approved mandateInfo: mitConsentAgreementRef: null mitConsentAgreementSrc: null mitProfileAction: null mitProfileAgreedOn: null mitProfileType: null mitTransactionId: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null status: Active totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: CreditCard updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-01 00:01:52' useDefaultRetryRule: true defaultPaymentMethodId: 4028839f7d26a155017d26af16ef0001 paymentGateway: null success: true schema: $ref: '#/components/schemas/GETAccountPaymentMethodType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List payment methods of an account tags: - Accounts /v1/accounts/{account-key}/payment-methods/cascading: get: summary: Retrieve configuration of cascading payment methods for an account description: | Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to retrieve the configuration information for Cascading Payment Method of a specified account, including the cascading consent value and the priority list of payment methods. Before you use this API operation, ensure that the Cascading Payment Method feature is enabled. For more information about the Cascading Payment Method feature, see Cascade payment methods. operationId: GetAccountPaymentMethodCascading parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account ID. in: path name: account-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: consent: true priorities: - paymentMethodId: 2c92c0f95be68649015bf14e001f2760 order: 1 - paymentMethodId: 2c92c0f95be68649015bf14e001f2761 order: 2 - paymentMethodId: 2c92c0f95be68649015bf14e001f2762 order: 3 success: true schema: $ref: '#/components/schemas/GetCascadingPaymentMethodsConfigurationResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string tags: - Accounts put: summary: Configure cascading payment methods for an account description: | Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to configure the cascading consent for a specified account and set up the priority list of payment methods to be used in Cascading Payment Method. Before you use this API operation, ensure that the Cascading Payment Method feature is enabled. For more information about the Cascading Payment Method feature, see Cascade payment methods. operationId: PutAccountPaymentMethodCascading parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account ID. in: path name: account-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PutCascadingPaymentMethodsConfigurationRequest' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string tags: - Accounts /v1/accounts/{account-key}/payment-methods/default: get: description: | Retrieves the default payment method of the specified customer account. **Note:** This operation also supports retrieving the custom payment method created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service. operationId: GET_AcountDefaultPaymentMethod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: AA_PICKLIST__c: null accountHolderInfo: accountHolderName: John Smith addressLine1: ABC addressLine2: EFT city: Example City country: United States email: example@google.com phone: '86123456789' state: Example State zipCode: '844000' accountKey: 4028839f7ca29000017ca29c1ce8003f bankIdentificationNumber: '411111' cardNumber: '************1111' createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-11-15 18:59:08' creditCardType: Visa deviceSessionId: null existingMandate: null expirationMonth: 11 expirationYear: 2027 id: 4028839f7d26a155017d26af16ef0001 identityNumber: '97370192024' ipAddress: null isDefault: true lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-11-15 18:59:08' lastTransactionStatus: Approved mandateInfo: mitConsentAgreementRef: null mitConsentAgreementSrc: null mitProfileAction: null mitProfileAgreedOn: null mitProfileType: null mitTransactionId: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null status: Active success: true totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: CreditCard updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-15 18:59:08' useDefaultRetryRule: true schema: $ref: '#/components/schemas/GETPaymentMethodResponseForAccount' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve the default payment method of an account tags: - Accounts /v1/accounts/{account-key}/summary: get: description: | Retrieves detailed information about the specified customer account. The response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages. ### Notes Returns only the six most recent subscriptions based on the subscription updatedDate. Within those subscriptions, there may be many rate plans and many rate plan charges. These items are subject to the maximum limit on the array size. operationId: GET_AccountSummary parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string - description: Indicate whether to exclude usage information in the response. The default value is `false`. in: query name: excludeUsage required: false schema: type: boolean responses: '200': content: application/json: examples: response: value: basicInfo: accountNumber: A00001115 additionalEmailAddresses: - contact1@example.com - contact2@example.com autoPay: true balance: 0 billCycleDay: 1 currency: USD defaultPaymentMethod: creditCardExpirationMonth: 10 creditCardExpirationYear: 2020 creditCardNumber: '************1111' creditCardType: Visa id: 2c92c8f83dabf9cf013daef12dd303b0 paymentMethodType: CreditCard id: 2c92a0f9391832b10139183e277a0042 invoiceDeliveryPrefsEmail: true invoiceDeliveryPrefsPrint: false lastInvoiceDate: '2013-02-11' lastPaymentAmount: 150248.1 lastPaymentDate: '2013-03-27' name: subscribeCallYan_1 partnerAccount: false paymentMethodCascadingConsent: false status: Active billToContact: address1: 1400 Bridge Pkwy address2: '' city: San Jose country: United States county: '' fax: '' firstName: Cheng id: 2c92a0f9391832b10139183e27940043 lastName: Zou state: California taxRegion: '' workEmail: contact@example.com workPhone: '5555551212' zipCode: '95135' invoices: - amount: 139722.1 balance: 0 dueDate: '2013-02-11' id: 2c92a0953a3fa95d013a407c10a60100 invoiceDate: '2013-02-11' invoiceNumber: INV00000323 status: Posted - amount: 10521 balance: 0 dueDate: '2012-08-11' id: 2c92a09739190dc60139194bcf1b0098 invoiceDate: '2012-08-11' invoiceNumber: INV00000160 status: Posted - amount: 10 balance: 0 dueDate: '2012-08-11' id: 2c92a09539190dbe0139190f42780012 invoiceDate: '2012-08-11' invoiceNumber: INV00000159 status: Posted payments: - effectiveDate: '2013-03-27' id: 2c92c8f83dabf9cf013daf3bfa0305a6 paidInvoices: - appliedPaymentAmount: 5 invoiceId: 2c92a09539190dbe0139190f42780012 invoiceNumber: INV00000159 - appliedPaymentAmount: 139722.1 invoiceId: 2c92a0953a3fa95d013a407c10a60100 invoiceNumber: INV00000323 - appliedPaymentAmount: 10521 invoiceId: 2c92a09739190dc60139194bcf1b0098 invoiceNumber: INV00000160 paymentNumber: P-00000075 paymentType: Electronic status: Processed - effectiveDate: '2012-08-11' id: 2c92a0f9391832b101391922ad5f049d paidInvoices: - appliedPaymentAmount: 5 invoiceId: 2c92a09539190dbe0139190f42780012 invoiceNumber: INV00000159 paymentNumber: P-00000056 paymentType: Electronic status: Processed soldToContact: address1: 278 Bridgeton Circle address2: '' city: San Jose country: United States county: '' fax: '' firstName: Bill id: 2c92a0f9391832b10139183e27940043 lastName: Cho state: California taxRegion: '' workEmail: contact@example.com workPhone: '5555551212' zipCode: '95135' subscriptions: - autoRenew: true id: 2c92c8f83dc4f752013dc72c24ee016d initialTerm: 12 ratePlans: - productName: Recurring Charge ratePlanName: QSF_Tier renewalTerm: 3 status: Active subscriptionNumber: A-S00001081 subscriptionStartDate: '2013-02-01' termEndDate: '2014-02-01' termStartDate: '2013-02-01' termType: TERMED - autoRenew: true id: 2c92c8f83dc4f752013dc72bb85c0127 initialTerm: 12 ratePlans: - productName: Recurring Charge ratePlanName: QSF_Tier renewalTerm: 3 status: Active subscriptionNumber: A-S00001080 subscriptionStartDate: '2013-02-01' termEndDate: '2014-02-01' termStartDate: '2013-02-01' termType: TERMED - autoRenew: false id: 2c92c8f83dc4f752013dc723fdab00d4 initialTerm: 10 ratePlans: - productName: Recurring Charge ratePlanName: QSF_Tier renewalTerm: 4 status: Cancelled subscriptionNumber: A-S00001079 subscriptionStartDate: '2013-02-01' termEndDate: '2014-04-01' termStartDate: '2013-12-01' termType: TERMED - autoRenew: false id: 2c92c8f83db0b4b4013db4717ad000ec initialTerm: 12 ratePlans: - productName: Recurring Charge ratePlanName: Month_PerUnit - productName: Recurring Charge ratePlanName: Month_PerUnit renewalTerm: 3 status: Active subscriptionNumber: A-S00001076 subscriptionStartDate: '2011-02-11' termEndDate: '2012-02-11' termStartDate: '2011-02-11' termType: TERMED - autoRenew: false id: 2c92c8f83db0b4b4013db3ab6a4d00bc initialTerm: 12 ratePlans: - productName: Recurring Charge ratePlanName: Month_PerUnit - productName: Recurring Charge ratePlanName: Month_PerUnit renewalTerm: 3 status: Active subscriptionNumber: A-S00001075 subscriptionStartDate: '2011-02-11' termEndDate: '2012-02-11' termStartDate: '2011-02-11' termType: TERMED - autoRenew: false id: 2c92c8f83db0b4b4013db3aa9fbd0090 initialTerm: 12 ratePlans: - productName: Recurring Charge ratePlanName: Month_PerUnit renewalTerm: 3 status: Active subscriptionNumber: A-S00001074 subscriptionStartDate: '2011-02-11' termEndDate: '2012-02-11' termStartDate: '2011-02-11' termType: TERMED success: true usage: - quantity: 10 startDate: 2012-02 unitOfMeasure: UOM - quantity: 10 startDate: 2012-01 unitOfMeasure: UOM schema: $ref: '#/components/schemas/GETAccountSummaryType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve an account summary tags: - Accounts /v1/contacts: post: description: | Creates a contact for a specified account. operationId: POST_CreateContact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTContactType' required: true responses: '200': content: application/json: examples: response: value: accountId: 6e767220676e6e61206776652075207570 accountNumber: A00000001 address1: 314, Bongora address2: near Tech City city: GHY contactDescription: This is a description for the contact country: India county: null fax: '6174' firstName: Kuhi homePhone: '1234123' id: 6b65657020726f6c6c696e672021 lastName: Das mobilePhone: '123213' nickname: Dorimi otherPhone: '2314213' otherPhoneType: Work personalEmail: kuhiroll@example.com state: Assam success: true taxRegion: null workEmail: null workPhone: null zipCode: '123456' schema: $ref: '#/components/schemas/ContactResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a contact tags: - Contacts /v1/contacts/{contactId}: delete: description: | Deletes a contact. operationId: DELETE_Contact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID of the contact that you want to delete. in: path name: contactId required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a contact tags: - Contacts get: description: | Retrieves detailed information about a specific contact. operationId: GET_Contact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID of the contact that you want to retrieve. in: path name: contactId required: true schema: type: string responses: '200': content: application/json: examples: response: value: accountId: 72756e2061726e642026206465736572742075 accountNumber: A00000001 address1: 567, Rose Apartment address2: Gate no. 2 city: Seattle contactDescription: This is a description country: United States county: King County fax: '123456' firstName: peter homePhone: '86123456789' id: 402881a2889f2e4301889f30e64e0019 lastName: parker mobilePhone: '1234567890' nickname: peet otherPhone: '11111111111111111' otherPhoneType: Work personalEmail: peet@example.com state: Washington success: true taxRegion: CA workEmail: work.mail@example.com workPhone: '3432' zipCode: '123134' schema: $ref: '#/components/schemas/ContactResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a contact tags: - Contacts put: description: | Updates a contact for a specified account. You can update contacts for cancelled accounts. operationId: PUT_Contact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID of the contact that you want to update. in: path name: contactId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTContactType' required: true responses: '200': content: application/json: examples: response: value: accountId: 6e767220676e6e61206d616b65207520637279 accountNumber: A00000001 address1: new Address address2: near Tech City city: Mumbai contactDescription: This is the new Description country: India county: null fax: '6174' firstName: Kuhi homePhone: '1234123' id: 8a90f50888a3036e0188ab7b3ffe7b8a lastName: Das mobilePhone: '123213' nickname: Dorimi otherPhone: '2314213' otherPhoneType: Work personalEmail: kuhiroll@example.com state: Assam success: true taxRegion: null workEmail: null workPhone: null zipCode: '123134' schema: $ref: '#/components/schemas/ContactResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a contact tags: - Contacts /v1/contacts/{contactId}/scrub: put: description: | Scrubs the sensitive data of a specific contact. You can use this operation to replace all sensitive data in a contact and its related contact snapshot with dummy values that will be stored in Zuora databases. After scrubbing a contact, it is good practice to delete it. Otherwise, it might cause errors in subsequent operations. **Note**: To use this operation, you must ensure that the "Scrub Sensitive Data of Contact" billing permission is enabled in your user role. Contact your tenant administrator if you want to enable this permission. See [Scrub Contacts](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/A_How_to_Manage_Customer_Accounts/B_Key_Contacts/Scrub_Contacts) for more information. operationId: PUT_ScrubContact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID of the contact that you want to scrub sensitive data from. in: path name: contactId required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Scrub a contact tags: - Contacts /v1/contact-snapshots/{contact-snapshot-id}: get: description: | Retrieves detailed information about the snapshot of a contact, either a bill-to contact or sold-to contact. operationId: GET_ContactSnapshot parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID of the contact snapshot to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab. in: path name: contact-snapshot-id required: true schema: type: string responses: '200': content: application/json: examples: response: value: address1: 4th street Custom colony address2: Thoraipakkam city: Chennai contactId: 4028c7628741ebe3018745f2c4123514 country: India county: null description: null fax: 43212 firstName: Pat homePhone: 9877 id: 4028c7628741ebe3018745f2c4133515 lastName: Parker mobilePhone: 1234567890 nickname: this is a nick name otherPhone: 9876543210 otherPhoneType: Work personalEmail: test123@gmail.com postalCode: 123456 state: TN success: true taxRegion: null workEmail: test123@zuora.com workPhone: 123 schema: $ref: '#/components/schemas/GETContactSnapshotResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a contact snapshot tags: - Contact Snapshots /v1/sign-up: post: description: | This call performs many actions. You can use this operation to implement the standard requirements for signing up a customer, such as validating the uniqueness of an account and limiting the number of subscriptions per account. Also, you can use this operation to create a subscription, generate an invoice, and collect payment for a new or existing customer. **Note:** You need to have the [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders/Orders_Harmonization) feature enabled to use this API. For a new customer, you can perform the following tasks in one call. Note that you can skip creating a payment meethod and still get the subscription and invoice successfully created. * Create an account * Create a payment method * Subscribe to a product in the product catalog and create a subscription * Generate an invoice * Collect payment For an existing customer, you can use an account identification field of an external system to specify the account. You can make [make asynchronous requests](https://developer.zuora.com/rest-api/general-concepts/async-requests/) when using the "Sign up" operation. operationId: POST_SignUp parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Charge_Metrics_Accept' requestBody: content: application/json: schema: $ref: '#/components/schemas/SignUpRequest' required: true responses: '200': content: application/json: examples: response: value: accountId: 4028818284f5f8130184f5fe1e9011e8 accountNumber: A00000001 invoiceId: 4028818284f5f8130184f5fe23b8120c invoiceNumber: INV00000001 orderNumber: O-00000001 paidAmount: 300 paymentId: 4028818284f5f8130184f5fe24b71218 paymentNumber: P-00000001 status: Completed subscriptionId: 4028818284f5f8130184f5fe214611f3 subscriptionNumber: A-S00000001 success: true schema: $ref: '#/components/schemas/SignUpResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Sign up tags: - Sign Up /v1/orders/preview: post: description: | **Notes**: - This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. - The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. - You cannot preview enhanced discounts and usage charges. Retrieves the preview of the charge metrics and invoice items of a specified order. Preview for subscriptions and order line items are both supported. This operation is only an order preview and no order is created. You can also use this operation to preview billing for a standalone order. For more information, see Preview billing for a standalone order. The Standalone Orders 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](https://support.zuora.com). #### Billing preview behavior regarding draft invoices By default, the billing preview behavior regarding draft invoices is as below: * When you preview billing for your order and the order contains subscriptions only, the draft invoices are excluded. * When you preview billing for your order and the order contains order line items only, the draft invoices are included. * When you preview billing for an order that contains both subscriptions order line items, the draft invoices are included for both subscriptions and order line items. However, if you want to always exclude the draft invoices in billing preview, submit a request at [Zuora Global Support](https://support.zuora.com). #### Limits on Orders API The limit of orders allowed on a subscription is 1000. The limit of order line items allowed in an order is 100. Zuora has the following limits on the Orders synchronous API to prevent performance degradation: * Up to 50 subscriptions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. * Up to 50 order actions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. * Up to 50 order actions are allowed on a single subscription in a [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations: * [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) * [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) * [Retrieve the status and response of a job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse) for checking the status of the asynchronous API operations Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation: * Up to 300 subscriptions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. * Up to 300 order actions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. * Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. operationId: POST_PreviewOrder parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTOrderPreviewRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true previewResult: invoices: - amount: 14.99 amountWithoutTax: 14.99 taxAmount: 0 targetDate: '2024-07-31' invoiceItems: - serviceStartDate: '2024-07-01' serviceEndDate: '2024-07-31' amountWithoutTax: 14.99 taxAmount: 0 chargeDescription: '' chargeName: Monthly Fee chargeNumber: null processingType: Charge productName: Music Service productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38 unitPrice: 14.99 subscriptionNumber: null orderLineItemNumber: null additionalInfo: quantity: 1 unitOfMeasure: '' numberOfDeliveries: 0 schema: $ref: '#/components/schemas/PostOrderPreviewResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Preview an order tags: - Orders /v1/async/orders/preview: post: description: | **Notes:** - This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August 2020). If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. - The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. - You cannot preview enhanced discounts and usage charges. In the case where a normal "Preview an order" operation call will time out, use this operation instead to preview an order asynchronously. A job will be previewing the order in the back end; the job ID will be returned for tracking the job status and result. #### Billing preview behavior regarding draft invoices By default, the billing preview behavior regarding draft invoices is as below: * When you preview billing for your order and the order contains subscriptions only, the draft invoices are excluded. * When you preview billing for your order and the order contains order line items only, the draft invoices are included. * When you preview billing for an order that contains both subscriptions order line items, the draft invoices are included for both subscriptions and order line items. However, if you want to always exclude the draft invoices in billing preview, submit a request at [Zuora Global Support](https://support.zuora.com). #### Limits on Orders API The limit of orders allowed on a subscription is 1000. The limit of order line items allowed in an order is 100. Zuora has the following limits on the Orders synchronous API to prevent performance degradation: * Up to 50 subscriptions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. * Up to 50 order actions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. * Up to 50 order actions are allowed on a single subscription in a [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations: * [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) * [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) * [Retrieve the status and response of a job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse) for checking the status of the asynchronous API operations Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation: * Up to 300 subscriptions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. * Up to 300 order actions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. * Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. operationId: POST_PreviewOrderAsynchronously parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTOrderPreviewAsyncRequestType' required: true responses: '202': content: application/json: examples: response: value: jobId: 2c90a02d676688200167770ce20601b6 schema: properties: jobId: description: The ID of an asynchronous job that will be returned for tracking the status and result of the job. format: UUID type: string type: object description: Accepted headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string Location: description: URL for accessing the job result, in the format of `/async-jobs/{jobId}`. For example, `/async-jobs/2c90a02d676688200167770ce20601b6` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Preview an order asynchronously tags: - Orders /v1/orders: get: description: | **Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions. **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. Retrieves information about all orders in your tenant. You can set the `status` query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value `all`, and orders of all statuses are returned. By default, it returns the first page of the orders. operationId: GET_AllOrders parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate. in: query name: dateFilterOption required: false schema: type: string - description: | The result will only contain the orders with the date of dateFilterOption later than or equal to this date. in: query name: startDate required: false schema: format: date type: string - description: | The result will only contains orders with the date of dateFilterOption earlier than or equal to this date. in: query name: endDate required: false schema: format: date type: string - description: The status of orders. in: query name: status required: false schema: enum: - all - cancelled - completed - draft - executing - failed - pending - scheduled type: string responses: '200': content: application/json: examples: response: value: orders: - createdBy: 2c989028622282520162235ab0f603ba createdDate: '2018-03-14 15:12:58' currency: USD customFields: order_cf_date__c: '2017-01-01' description: This is a description for the Order. existingAccountNumber: accountA_Num orderDate: '2017-03-01' orderLineItems: - UOM: null accountingCode: null amount: 10000 amountPerUnit: 5000 amountWithoutTax: 10000 billTargetDate: null billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa billToSnapshotId: 4028fc8487c0a43c0187c12a91500060 customFields: orderLineItemCF__c: olinumber-023 description: With Dual Stereo Microphones, HD 1080p, Black,USB connectivity for ease of use. id: 4028fc827a0e48c1017a0e4dccc60002 invoiceGroupNumber: N-0001 invoiceOwnerAccountId: ff80808187ff38570187ff433cbd38ef invoiceOwnerAccountName: AC_AC_16836148090011683614809001 invoiceOwnerAccountNumber: AN_1683614809001 itemName: webcam itemNumber: '1' itemState: Executing itemType: Product listPrice: 118 listPricePerUnit: 59 orderId: 4028fc827a0e48c1017a0e58b9330014 ownerAccountId: ff80808187ff38570187ff433f974203 ownerAccountName: AC_AC_16836148099861683614809986 ownerAccountNumber: AN_1683614809986 productCode: C9201 productRatePlanChargeId: null purchaseOrderNumber: 960-000764 quantity: 2 soldTo: 4028fc828244a0ac018244dfc9a90bee soldToSnapshotId: 4028fc828244a0ac018244dfc9b00bf0 transactionEndDate: '2021-02-01' transactionStartDate: '2021-02-01' orderNumber: O-00000002 status: Completed subscriptions: - baseVersion: 1 customFields: sub_cf_picklist__c: null newVersion: 2 orderActions: - customFields: oa_cf_text__c: null sequence: 0 triggerDates: - name: ContractEffective triggerDate: '2017-03-01' - name: ServiceActivation triggerDate: '2017-03-01' - name: CustomerAcceptance triggerDate: '2017-03-01' type: UpdateProduct updateProduct: chargeUpdates: - billing: billingPeriodAlignment: null chargeNumber: C-00000001 customFields: srpc_cf_picklist__c: null description: null effectiveDate: specificTriggerDate: null newRatePlanChargeId: 2c989028622282520162235adabc0651 pricing: recurringVolume: priceChangeOption: null priceIncreasePercentage: null quantity: 7 tiers: [] uniqueToken: null customFields: {} newRatePlanId: 2c989028622282520162235ada870649 ratePlanId: 2c989028622282520162235acd1b05d2 specificUpdateDate: null uniqueToken: null subscriptionNumber: A-S00000001 updatedBy: 2c989028622282520162235ab0f603ba updatedDate: '2018-03-14 15:12:58' - createdBy: 2c989028622282520162235ab0f603ba createdDate: '2018-03-14 15:12:55' currency: USD existingAccountNumber: accountA_Num orderDate: '2017-01-01' orderNumber: O-00000001 status: Completed subscriptions: - baseVersion: null customFields: sub_cf_picklist__c: sub123 newVersion: 1 orderActions: - createSubscription: invoiceSeparately: null invoiceGroupNumber: N-0001 notes: null subscribeToRatePlans: - chargeOverrides: - billing: billCycleDay: null billCycleType: null billingPeriod: null billingPeriodAlignment: null billingTiming: null specificBillingPeriod: null weeklyBillCycleDay: null chargeNumber: C-00000001 customFields: srpc_cf_picklist__c: null description: null endDate: endDateCondition: null specificEndDate: null upToPeriods: null upToPeriodsType: null pricing: recurringVolume: listPriceBase: Per_Billing_Period priceChangeOption: null priceIncreasePercentage: null quantity: 12 tiers: [] productRateplanChargeId: 2c989028622282520162235aca7a05b9 startDate: specificTriggerDate: null uniqueToken: null customFields: {} newRatePlanId: 2c989028622282520162235acd1b05d2 productRatePlanId: 2c989028622282520162235ac91605b3 uniqueToken: null subscriptionOwnerAccountNumber: accountA_Num terms: autoRenew: false initialTerm: period: 12 periodType: Month startDate: '2017-01-01' termType: TERMED renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerms: - period: 0 periodType: Month customFields: order_cf_date__c: '2017-01-01' sequence: 0 triggerDates: - name: ContractEffective triggerDate: '2017-01-01' - name: ServiceActivation triggerDate: '2017-01-01' - name: CustomerAcceptance triggerDate: '2017-01-01' type: CreateSubscription subscriptionNumber: A-S00000001 success: true updatedBy: 2c989028622282520162235ab0f603ba updatedDate: '2018-03-14 15:12:55' schema: $ref: '#/components/schemas/GetAllOrdersResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List orders tags: - Orders post: description: |- **Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. You can use this operation to create subscriptions and make changes to subscriptions by creating orders. You can also use this operation to create order line items by creating orders. The following tutorials demonstrate how to use this operation: * [Create a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/A_Create_a_Subscription) * [Add a Product to a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/A_Add_a_Product_to_a_Subscription) * [Create a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/B_Create_a_Ramp_Deal) * [Add a Product Mid-Interval Update on a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/E_Update_a_Product_in_a_Ramp_Deal) * [Add a Product in a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/C_Add_a_Product_in_a_Ramp_Deal) * [Change the Terms and Conditions of a Ramp Deal](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/D_Change_the_Terms_and_Conditions_of_a_Ramp_Deal_and_Update_the_Ramp) * [Change the Owner of a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Change_the_Owner_of_a_Subscription) * [Change the Terms and Conditions of a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Change_the_Terms_and_Conditions_of_a_Subscription) * [Renew a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Renew_a_Subscription) * [Renew a Subscription and Upgrade a Product](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Renew_a_Subscription_and_Upgrade_a_Product) * [Replace a Product in a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Replace_a_Product_in_a_Subscription) * [Update a Product in a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription) * [Cancel a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/D_Cancel_a_Subscription) * [Remove a Product from a Subscription](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/D_Remove_a_Product_from_a_Subscription) * [Create sales order line items](https://knowledgecenter.zuora.com/Zuora_Billing/Manage_non-subscription_transactions/Order_Line_Items/B_Manage_Order_Line_Items/AA_Create_a_sales_order_line_item_with_fulfillments) * [Associate order line items with new subscriptions](https://knowledgecenter.zuora.com/Zuora_Billing/Manage_non-subscription_transactions/Order_Line_Items/B_Manage_Order_Line_Items/C_Associate_an_order_line_item_with_a_new_subscription) * [Return order line items](https://knowledgecenter.zuora.com/Zuora_Billing/Manage_non-subscription_transactions/Order_Line_Items/B_Manage_Order_Line_Items/DA_Return_an_order_line_item_with_fulfillments) You can also use this operation to create orders and save the orders as Scheduled Orders. In addition, you can use this operation to place a standalone order to subscribe without pre-defining a product catalog in Zuora Billing. For more information, see Create a subscription using a standalone order. The Standalone Orders 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](https://support.zuora.com). **Note:** If you received a timeout error message when creating an order, the call is still running in the backend and the order will be created. The limit of orders allowed on a subscription is 1000. The limit of order line items allowed in an order is 100. Zuora has the following limits on the Orders synchronous API to prevent performance degradation: * Up to 50 subscriptions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. * Up to 50 order actions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. * Up to 50 order actions are allowed on a single subscription in a [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations: * [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) * [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) * [Retrieve the status and response of a job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse) for checking the status of the asynchronous API operations Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation: * Up to 300 subscriptions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. * Up to 300 order actions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. * Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. **Note:** When you are to suspend a subcription (via the `suspend` order action), if in the same "Create an order" call you are to perform other subsequent order actions on the supscription to suspend, you must first resume the subscription (via a `resume` order action). **Note:** When using this operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. This means that the invoice will not be generated, the subscription will not be created, and the account will not be created. **Note:** The characters `#`, `?`, and `/` are not allowed in the Orders operations. operationId: POST_Order parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Specify whether to return IDs associated with the numbers returned in the "Create an order" operation. in: query name: returnIds required: false schema: default: false type: boolean - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTOrderRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true orderNumber: O-00000354 accountNumber: A00000097 status: Completed subscriptionNumbers: - A-S00000129 schema: $ref: '#/components/schemas/PostOrderResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create an order tags: - Orders /v1/async/orders: post: description: | **Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. In the case where a normal "Create an order" operation call will time out, use this operation instead to create an order asynchronously. A job will be creating the order in the back end; the job ID will be returned for tracking the job status and result. Note that this operation doesn't support auto-refund and invoice write-off during subscription cancellation. Use the "Create an order" operation instead. The limit of orders allowed on a subscription is 1000. The limit of order line items allowed in an order is 100. Zuora has the following limits on the Orders synchronous API to prevent performance degradation: * Up to 50 subscriptions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. * Up to 50 order actions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. * Up to 50 order actions are allowed on a single subscription in a [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations: * [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) * [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) * [Retrieve the status and response of a job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse) for checking the status of the asynchronous API operations Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation: * Up to 300 subscriptions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. * Up to 300 order actions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. * Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. operationId: POST_CreateOrderAsynchronously parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Specify whether to return IDs for the [Get job status and response](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse) operation. If you set this query parameter to `true`, the corresponding IDs, which are associated with the numbers returned in this operation, can be returned in the "Get job status and response" response body. in: query name: returnIds required: false schema: default: false type: boolean - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTOrderAsyncRequestType' required: true responses: '202': content: application/json: examples: response: value: jobId: 1bc24f315d7b48d3a20245bfe73bdceb success: 'true' schema: properties: jobId: description: The ID of an asynchronous job that will be returned for tracking the status and result of the job. format: UUID type: string success: description: Indicates whether the operation call succeeded. type: boolean type: object description: Accepted headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string Location: description: URL for accessing the job result, in the format of `/async-jobs/{jobId}`. For example, `/async-jobs/1bc24f315d7b48d3a20245bfe73bdceb` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Create an order asynchronously tags: - Orders /v1/orders/{orderNumber}: delete: description: | **Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. Deletes a specified order. * All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version. * All the order line items created in this order are deleted. You are not allowed to delete an order in the following situations: - The charges that are affected by this order are invoiced. - The order is reverted and in the `Reverted` status. operationId: DELETE_Order parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The number of the order to be deleted. in: path name: orderNumber required: true schema: format: string type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete an order tags: - Orders get: description: | **Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions. **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. Retrieves the detailed information about a specified order. operationId: GET_Order parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The order number to be retrieved. in: path name: orderNumber required: true schema: format: string type: string - description: Retrieves the invoice owner account details and subscription owner account details in the Order. in: query name: getAccountDetails schema: type: boolean responses: '200': content: application/json: examples: response: value: order: createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-12-13 17:21:43' currency: USD customFields: {} description: This is a description for the Order. existingAccountNumber: A00000101 existingAccountDetails: basicInfo: accountNumber: A00000001 batch: Batch1 communicationProfileId: 303d186840e611df817c002185d714e1 crmId: '' id: 402892c74c9193cd014c91d35b0a0132 invoiceTemplateId: null name: Test notes: '' partnerAccount: false profileNumber: CP-00000012 salesRep: '' sequenceSetId: null status: Active summaryStatementTemplateId: null purchaseOrderNumber: '' billToContact: address1: '' address2: '' city: '' country: null county: null fax: '' firstName: Test homePhone: '' id: 2c9081a03c6d7b51013c6d7e46c80a17 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a orderDate: '2018-10-01' orderLineItems: - UOM: null accountingCode: null amount: 10000 amountPerUnit: 5000 amountWithoutTax: 10000 billTargetDate: null billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa billToSnapshotId: 4028fc8487c0a43c0187c12a91500060 customFields: orderLineItemCF__c: olinumber-023 description: With Dual Stereo Microphones, HD 1080p, Black,USB connectivity for ease of use. id: 4028fc827a0e48c1017a0e4dccc60002 invoiceGroupNumber: N-0001 invoiceOwnerAccountId: ff80808187ff38570187ff433cbd38ef invoiceOwnerAccountName: AC_AC_16836148090011683614809001 invoiceOwnerAccountNumber: AN_1683614809001 itemName: webcam itemNumber: '1' itemState: Executing itemType: Product listPrice: 118 listPricePerUnit: 59 orderId: 4028fc827a0e48c1017a0e58b9330014 ownerAccountId: ff80808187ff38570187ff433f974203 ownerAccountName: AC_AC_16836148099861683614809986 ownerAccountNumber: AN_1683614809986 productCode: C9201 productRatePlanChargeId: null purchaseOrderNumber: 960-000764 quantity: 2 soldTo: 4028fc828244a0ac018244dfc9a90bee soldToSnapshotId: 4028fc828244a0ac018244dfc9b00bf0 transactionEndDate: '2021-02-01' transactionStartDate: '2021-02-01' orderNumber: O-00000282 status: Completed subscriptions: - baseVersion: 1 customFields: {} externallyManagedBy: null newVersion: 2 orderActions: - customFields: {} sequence: 0 triggerDates: - name: ContractEffective triggerDate: '2018-12-01' - name: ServiceActivation triggerDate: '2018-12-01' - name: CustomerAcceptance triggerDate: '2018-12-01' type: UpdateProduct updateProduct: chargeUpdates: - billing: billingPeriodAlignment: null chargeNumber: C-00000210 customFields: {} description: null effectiveDate: specificTriggerDate: null newRatePlanChargeId: 2c98919c67a5ae9d0167a6df304b0372 pricing: recurringPerUnit: listPrice: 20 priceChangeOption: null priceIncreasePercentage: null quantity: null uniqueToken: null customFields: {} newRatePlanId: 2c98919c67a5ae9d0167a6df3011036e ratePlanId: 2c98919c67a5ae9d0167a68f8eb20262 specificUpdateDate: null uniqueToken: null subscriptionNumber: A-S00000100 subscriptionOwnerAccountNumber: A00000001 subscriptionOwnerAccountDetails: accountNumber: A00000001 batch: Batch1 communicationProfileId: 303d186840e611df817c002185d714e1 crmId: '' id: 402892c74c9193cd014c91d35b0a0132 invoiceTemplateId: null name: Test notes: '' partnerAccount: false profileNumber: CP-00000012 salesRep: '' sequenceSetId: null status: Active summaryStatementTemplateId: null purchaseOrderNumber: '' billToContact: address1: '' address2: '' city: '' country: null county: null fax: '' firstName: Test homePhone: '' id: 2c9081a03c6d7b51013c6d7e46c80a17 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' - baseVersion: 1 customFields: {} externallyManagedBy: null newVersion: 2 orderActions: - customFields: {} sequence: 0 suspend: suspendDate: '2018-12-13' suspendPeriods: null suspendPeriodsType: null suspendPolicy: Today suspendSpecificDate: null triggerDates: - name: ContractEffective triggerDate: '2018-12-01' - name: ServiceActivation triggerDate: '2018-12-01' - name: CustomerAcceptance triggerDate: '2018-12-01' type: Suspend subscriptionNumber: A-S00000101 subscriptionOwnerAccountNumber: A00000001 subscriptionOwnerAccountDetails: accountNumber: A00000001 batch: Batch1 communicationProfileId: 303d186840e611df817c002185d714e1 crmId: '' id: 402892c74c9193cd014c91d35b0a0132 invoiceTemplateId: null name: Test notes: '' partnerAccount: false profileNumber: CP-00000012 salesRep: '' sequenceSetId: null status: Active summaryStatementTemplateId: null purchaseOrderNumber: '' soldToContact: address1: '' address2: '' city: '' country: null county: null fax: '' firstName: Test homePhone: '' id: 2c9081a03c6d7b51013c6d7e46c80a17 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' - baseVersion: 2 customFields: {} externallyManagedBy: null newVersion: 3 orderActions: - customFields: {} resume: extendsTerm: true resumeDate: '2018-12-23' resumePeriods: 10 resumePeriodsType: Day resumePolicy: FixedPeriodsFromSuspendDate resumeSpecificDate: null sequence: 0 triggerDates: - name: ContractEffective triggerDate: '2018-12-12' - name: ServiceActivation triggerDate: '2018-12-12' - name: CustomerAcceptance triggerDate: '2018-12-12' type: Resume - customFields: {} sequence: 1 termsAndConditions: autoRenew: null invoiceGroupNumber: N-0001 clearingExistingInvoiceGroupNumber: false initialTerm: period: 375 periodType: Day startDate: null termType: null renewalSetting: null renewalTerms: - period: null periodType: null triggerDates: - name: ContractEffective triggerDate: '2018-12-12' - name: ServiceActivation triggerDate: '2018-12-12' - name: CustomerAcceptance triggerDate: '2018-12-12' type: TermsAndConditions subscriptionNumber: A-S00000102 subscriptionOwnerAccountNumber: A00000001 updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-12-13 17:21:45' success: true schema: $ref: '#/components/schemas/GetOrderResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve an order tags: - Orders put: description: | **Notes:** - This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. - Update an order is only valid for draft or scheduled orders. - This operation doesn't support auto-refund and invoice write-off during subscription cancellation. Use the "Create an order" operation instead. - You must provide full payload when using the "Update an order" operation. That is, if you want to edit one order action, you need to provide all other order actions in the payload. Otherwise, the other order actions will be removed. operationId: PUT_Order parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Order number of a order in which you are to update. in: path name: orderNumber required: true schema: format: string type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTOrderRequestType' required: true responses: '200': content: application/json: examples: response: value: accountNumber: A00000001 invoiceNumbers: - INV00000001 orderNumber: OM-00002 paidAmount: '300' paymentNumber: P-00000002 status: Pending subscriptions: - status: Pending Activation subscriptionNumber: SM-00001 - status: Pending Acceptance subscriptionNumber: SM-00002 - status: Active subscriptionNumber: SM-00003 - status: Pending Acceptance subscriptionNumber: SM-00004 - status: Suspended subscriptionNumber: SM-00005 - status: Active subscriptionNumber: SM-00006 success: true schema: $ref: '#/components/schemas/PutOrderResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update an order tags: - Orders /v1/async-jobs/{jobId}: get: description: | **Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. Get the status and response of an asynchronous job. Currently, an asynchronous job created by "Create an order asynchronously" or "Preview an order asynchronously" is supported. operationId: GET_JobStatusAndResponse parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: UUID of the asynchronous job created by an asynchronous API operation. in: path name: jobId required: true schema: format: UUID type: string responses: '200': content: application/json: examples: response: value: errors: null result: accountNumber: A00000001 invoiceNumbers: - INV00000001 orderLineItems: - id: bd78c0522adf42c2aa0fccacc997fa20 itemNumber: '116' orderNumber: OM-00002 paidAmount: 300 paymentNumber: P-00000002 status: Pending subscriptions: - status: Pending Activation subscriptionNumber: SM-00001 - status: Pending Acceptance subscriptionNumber: SM-00002 - status: Active subscriptionNumber: SM-00003 - status: Pending Acceptance subscriptionNumber: SM-00004 success: true status: Completed success: true schema: properties: errors: description: Error messages returned if the job failed. type: string result: $ref: '#/components/schemas/JobResult' status: description: Type of job status. enum: - Processing - Failed - Completed type: string success: description: Indicates whether the operation call succeeded. type: boolean type: object description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve the status and response of a job tags: - Orders /v1/orders/subscriptionOwner/{accountNumber}: get: description: | **Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions. **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. Retrieves the detailed information about all orders for a specified subscription owner. Any orders containing the changes on the subscriptions owned by this account are returned. **Note**: You cannot retrieve detailed information about draft orders or scheduled orders through this operation. operationId: GET_OrdersBySubscriptionOwner parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The subscription owner account number. in: path name: accountNumber required: true schema: format: string type: string - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The date type to filter on. This field value can be 'orderDate' or 'updatedDate'. Default is orderDate. in: query name: dateFilterOption required: false schema: type: string - description: | The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date. in: query name: startDate required: false schema: format: date type: string - description: | The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date. in: query name: endDate required: false schema: format: date type: string responses: '200': content: application/json: examples: response: value: orders: - createdBy: 2c989028622282520162235ab0f603ba createdDate: '2018-03-14 15:12:58' currency: USD customFields: order_cf_date__c: '2017-01-01' description: This is a description for the Order. existingAccountNumber: accountA_Num invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a orderDate: '2017-03-01' orderNumber: O-00000002 status: Completed subscriptions: - baseVersion: 1 customFields: sub_cf_picklist__c: null newVersion: 2 orderActions: - customFields: oa_cf_text__c: null sequence: 0 triggerDates: - name: ContractEffective triggerDate: '2017-03-01' - name: ServiceActivation triggerDate: '2017-03-01' - name: CustomerAcceptance triggerDate: '2017-03-01' type: UpdateProduct updateProduct: chargeUpdates: - billing: billingPeriodAlignment: null chargeNumber: C-00000001 customFields: srpc_cf_picklist__c: null description: null effectiveDate: specificTriggerDate: null newRatePlanChargeId: 2c989028622282520162235adabc0651 pricing: recurringVolume: priceChangeOption: null priceIncreasePercentage: null quantity: 7 tiers: [] uniqueToken: null customFields: {} newRatePlanId: 2c989028622282520162235ada870649 ratePlanId: 2c989028622282520162235acd1b05d2 specificUpdateDate: null uniqueToken: null subscriptionNumber: A-S00000001 updatedBy: 2c989028622282520162235ab0f603ba updatedDate: '2018-03-14 15:12:58' - createdBy: 2c989028622282520162235ab0f603ba createdDate: '2018-03-14 15:12:55' currency: USD customFields: order_cf_date__c: '2017-01-01' existingAccountNumber: accountA_Num orderDate: '2017-01-01' orderNumber: O-00000001 status: Completed subscriptions: - baseVersion: null customFields: sub_cf_picklist__c: sub123 newVersion: 1 orderActions: - createSubscription: invoiceSeparately: null notes: null subscribeToRatePlans: - chargeOverrides: - billing: billCycleDay: null billCycleType: null billingPeriod: null billingPeriodAlignment: null billingTiming: null specificBillingPeriod: null weeklyBillCycleDay: null chargeNumber: C-00000001 customFields: srpc_cf_picklist__c: null description: null endDate: endDateCondition: null specificEndDate: null upToPeriods: null upToPeriodsType: null pricing: recurringVolume: listPriceBase: Per_Billing_Period priceChangeOption: null priceIncreasePercentage: null quantity: 12 tiers: [] productRateplanChargeId: 2c989028622282520162235aca7a05b9 startDate: specificTriggerDate: null uniqueToken: null customFields: {} newRatePlanId: 2c989028622282520162235acd1b05d2 productRatePlanId: 2c989028622282520162235ac91605b3 uniqueToken: null subscriptionOwnerAccountNumber: accountA_Num terms: autoRenew: false initialTerm: period: 12 periodType: Month startDate: '2017-01-01' termType: TERMED renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerms: - period: 0 periodType: Month customFields: oa_cf_text__c: oa cf test sequence: 0 triggerDates: - name: ContractEffective triggerDate: '2017-01-01' - name: ServiceActivation triggerDate: '2017-01-01' - name: CustomerAcceptance triggerDate: '2017-01-01' type: CreateSubscription subscriptionNumber: A-S00000001 updatedBy: 2c989028622282520162235ab0f603ba updatedDate: '2018-03-14 15:12:55' success: true schema: $ref: '#/components/schemas/GetOrdersResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List orders of a subscription owner tags: - Orders /v1/orders/subscription/{subscriptionNumber}: get: description: | **Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions. **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. Retrieves the detailed information about all orders for a specified subscription. You can set the `status` query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value `all`, and orders of all statuses are returned. operationId: GET_OrdersBySubscriptionNumber parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The subscription number. in: path name: subscriptionNumber required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The date type to filter on. This field value can be 'orderDate' or 'updatedDate'. Default is orderDate. in: query name: dateFilterOption required: false schema: type: string - description: | The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date. in: query name: startDate required: false schema: format: date type: string - description: | The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date. in: query name: endDate required: false schema: format: date type: string - description: The status of orders. in: query name: status required: false schema: enum: - all - cancelled - completed - draft - executing - failed - pending - scheduled type: string responses: '200': content: application/json: examples: response: value: orders: - createdBy: 2c989028622282520162235ab0f603ba createdDate: '2018-03-14 15:12:58' currency: USD customFields: order_cf_date__c: '2017-01-01' description: This is a description for the Order. existingAccountNumber: accountA_Num invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a orderDate: '2017-03-01' orderNumber: O-00000002 status: Completed subscriptions: - baseVersion: 1 customFields: sub_cf_picklist__c: null newVersion: 2 orderActions: - customFields: oa_cf_text__c: null sequence: 0 triggerDates: - name: ContractEffective triggerDate: '2017-03-01' - name: ServiceActivation triggerDate: '2017-03-01' - name: CustomerAcceptance triggerDate: '2017-03-01' type: UpdateProduct updateProduct: chargeUpdates: - billing: billingPeriodAlignment: null chargeNumber: C-00000001 customFields: srpc_cf_picklist__c: null description: null effectiveDate: specificTriggerDate: null newRatePlanChargeId: 2c989028622282520162235adabc0651 pricing: recurringVolume: priceChangeOption: null priceIncreasePercentage: null quantity: 7 tiers: [] uniqueToken: null customFields: {} newRatePlanId: 2c989028622282520162235ada870649 ratePlanId: 2c989028622282520162235acd1b05d2 specificUpdateDate: null uniqueToken: null subscriptionNumber: A-S00000001 updatedBy: 2c989028622282520162235ab0f603ba updatedDate: '2018-03-14 15:12:58' - createdBy: 2c989028622282520162235ab0f603ba createdDate: '2018-03-14 15:12:55' currency: USD customFields: order_cf_date__c: '2017-01-01' existingAccountNumber: accountA_Num orderDate: '2017-01-01' orderNumber: O-00000001 status: Completed subscriptions: - baseVersion: null customFields: sub_cf_picklist__c: sub123 newVersion: 1 orderActions: - createSubscription: invoiceSeparately: null notes: null subscribeToRatePlans: - chargeOverrides: - billing: billCycleDay: null billCycleType: null billingPeriod: null billingPeriodAlignment: null billingTiming: null specificBillingPeriod: null weeklyBillCycleDay: null chargeNumber: C-00000001 customFields: srpc_cf_picklist__c: null description: null endDate: endDateCondition: null specificEndDate: null upToPeriods: null upToPeriodsType: null pricing: recurringVolume: listPriceBase: Per_Billing_Period priceChangeOption: null priceIncreasePercentage: null quantity: 12 tiers: [] productRateplanChargeId: 2c989028622282520162235aca7a05b9 startDate: specificTriggerDate: null uniqueToken: null customFields: {} newRatePlanId: 2c989028622282520162235acd1b05d2 productRatePlanId: 2c989028622282520162235ac91605b3 uniqueToken: null subscriptionOwnerAccountNumber: accountA_Num terms: autoRenew: false initialTerm: period: 12 periodType: Month startDate: '2017-01-01' termType: TERMED renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerms: - period: 0 periodType: Month customFields: oa_cf_text__c: oa cf test sequence: 0 triggerDates: - name: ContractEffective triggerDate: '2017-01-01' - name: ServiceActivation triggerDate: '2017-01-01' - name: CustomerAcceptance triggerDate: '2017-01-01' type: CreateSubscription subscriptionNumber: A-S00000001 updatedBy: 2c989028622282520162235ab0f603ba updatedDate: '2018-03-14 15:12:55' success: true schema: $ref: '#/components/schemas/GetOrdersResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List orders by subscription number tags: - Orders /v1/orders/invoiceOwner/{accountNumber}: get: description: | **Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions. **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. Retrieves the detailed information about all orders for a specified invoice owner. You can set the `status` query parameter to an order status to retrieve orders in that order status. If you do not set a value for this query parameter, the query parameter has a default value `all`, and orders of all statuses are returned. operationId: GET_OrdersByInvoiceOwner parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The invoice owner account number. in: path name: accountNumber required: true schema: format: string type: string - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate. in: query name: dateFilterOption required: false schema: type: string - description: | The result will only contain the orders with the date of dateFilterOption later than or equal to this date. in: query name: startDate required: false schema: format: date type: string - description: | The result will only contain the orders with the date of dateFilterOption earlier than or equal to this date. in: query name: endDate required: false schema: format: date type: string - description: The status of orders. in: query name: status required: false schema: enum: - all - cancelled - completed - draft - executing - failed - pending - scheduled type: string responses: '200': content: application/json: examples: response: value: orders: - createdBy: 2c989028622282520162235ab0f603ba createdDate: '2018-03-14 15:12:58' currency: USD customFields: order_cf_date__c: '2017-01-01' description: This is a description for the Order. existingAccountNumber: accountA_Num invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a orderDate: '2017-03-01' orderNumber: O-00000002 status: Completed subscriptions: - baseVersion: 1 customFields: sub_cf_picklist__c: null newVersion: 2 orderActions: - customFields: oa_cf_text__c: null sequence: 0 triggerDates: - name: ContractEffective triggerDate: '2017-03-01' - name: ServiceActivation triggerDate: '2017-03-01' - name: CustomerAcceptance triggerDate: '2017-03-01' type: UpdateProduct updateProduct: chargeUpdates: - billing: billingPeriodAlignment: null chargeNumber: C-00000001 customFields: srpc_cf_picklist__c: null description: null effectiveDate: specificTriggerDate: null newRatePlanChargeId: 2c989028622282520162235adabc0651 pricing: recurringVolume: priceChangeOption: null priceIncreasePercentage: null quantity: 7 tiers: [] uniqueToken: null customFields: {} newRatePlanId: 2c989028622282520162235ada870649 ratePlanId: 2c989028622282520162235acd1b05d2 specificUpdateDate: null uniqueToken: null subscriptionNumber: A-S00000001 updatedBy: 2c989028622282520162235ab0f603ba updatedDate: '2018-03-14 15:12:58' - createdBy: 2c989028622282520162235ab0f603ba createdDate: '2018-03-14 15:12:55' currency: USD customFields: order_cf_date__c: '2017-01-01' existingAccountNumber: accountA_Num orderDate: '2017-01-01' orderNumber: O-00000001 status: Completed subscriptions: - baseVersion: null customFields: sub_cf_picklist__c: sub123 newVersion: 1 orderActions: - createSubscription: invoiceSeparately: null notes: null subscribeToRatePlans: - chargeOverrides: - billing: billCycleDay: null billCycleType: null billingPeriod: null billingPeriodAlignment: null billingTiming: null specificBillingPeriod: null weeklyBillCycleDay: null chargeNumber: C-00000001 customFields: srpc_cf_picklist__c: null description: null endDate: endDateCondition: null specificEndDate: null upToPeriods: null upToPeriodsType: null pricing: recurringVolume: listPriceBase: Per_Billing_Period priceChangeOption: null priceIncreasePercentage: null quantity: 12 tiers: [] productRateplanChargeId: 2c989028622282520162235aca7a05b9 startDate: specificTriggerDate: null uniqueToken: null customFields: {} newRatePlanId: 2c989028622282520162235acd1b05d2 productRatePlanId: 2c989028622282520162235ac91605b3 uniqueToken: null subscriptionOwnerAccountNumber: accountA_Num terms: autoRenew: false initialTerm: period: 12 periodType: Month startDate: '2017-01-01' termType: TERMED renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerms: - period: 0 periodType: Month customFields: oa_cf_text__c: oa cf test sequence: 0 triggerDates: - name: ContractEffective triggerDate: '2017-01-01' - name: ServiceActivation triggerDate: '2017-01-01' - name: CustomerAcceptance triggerDate: '2017-01-01' type: CreateSubscription subscriptionNumber: A-S00000001 updatedBy: 2c989028622282520162235ab0f603ba updatedDate: '2018-03-14 15:12:55' success: true schema: $ref: '#/components/schemas/GetOrdersResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List orders of an invoice owner tags: - Orders /v1/orders/{orderNumber}/customFields: put: description: | **Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions. **Note:** To update the custom fields of an order line item, you must use the "Update an order line item" or "Update order line items" operation. Updates the custom fields of a specified order. operationId: PUT_UpdateOrderCustomFields parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The order number. in: path name: orderNumber required: true schema: format: string type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTOrderPatchRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update order custom fields tags: - Orders /v1/subscriptions/{subscriptionNumber}/customFields: put: description: | **Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. Updates the custom fields of a specified subscription. operationId: PUT_UpdateSubscriptionCustomFields parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The subscription number to be updated. in: path name: subscriptionNumber required: true schema: format: string type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionPatchRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update subscription custom fields tags: - Orders /v1/orders/{orderNumber}/triggerDates: put: description: | **Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. Updates the triggering dates for either of the following order actions: * CreateSubscription * AddProduct * UpdateProduct * RemoveProduct * RenewSubscription * TermsAndConditions operationId: PUT_OrderTriggerDates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Order number of a pending order in which you are to update an order action's triggering dates. in: path name: orderNumber required: true schema: format: string type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTOrderActionTriggerDatesRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true orderNumber: O-00000408 status: Completed accountNumber: A00000097 subscriptions: - subscriptionNumber: A-S00000143 status: Active schema: $ref: '#/components/schemas/PUTOrderTriggerDatesResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update order action trigger dates tags: - Orders /v1/orders/{orderNumber}/activate: put: description: | **Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. Activate order is only available for draft orders. operationId: PUT_OrderActivate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Order number of a order in which you are to activate. in: path name: orderNumber required: true schema: format: string type: string responses: '200': content: application/json: examples: response: value: accountNumber: A00000001 invoiceNumbers: - INV00000001 orderLineItems: - id: bd78c0522adf42c2aa0fccacc997fa20 itemNumber: '116' orderNumber: OM-00002 paidAmount: 300 paymentNumber: P-00000002 status: Pending subscriptions: - status: Pending Activation subscriptionNumber: SM-00001 - status: Pending Acceptance subscriptionNumber: SM-00002 - status: Active subscriptionNumber: SM-00003 - status: Pending Acceptance subscriptionNumber: SM-00004 - status: Suspended subscriptionNumber: SM-00005 - status: Active subscriptionNumber: SM-00006 success: true schema: $ref: '#/components/schemas/PostOrderResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Activate an order tags: - Orders /v1/orders/{orderNumber}/cancel: put: description: |- **Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. **Note:** Cancellation is only valid for draft or scheduled orders. If the order is not in draft or scheduled status, the API returns an error. operationId: PUT_OrderCancel parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The order number of the draft order you wish to cancel. in: path name: orderNumber required: true schema: format: string type: string requestBody: content: application/json: schema: properties: cancelReason: description: The reason for cancelling the order. example: Customer cancelled the order. type: string type: object responses: '200': content: application/json: examples: response: value: CancelReason: Customer cancelled the order. accountNumber: A00000001 orderNumber: OM-00002 status: Cancelled success: true schema: $ref: '#/components/schemas/PutOrderCancelResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Cancel an order tags: - Orders /v1/orders/{orderNumber}/revert: post: description: | Reverts an order though this operation. **Note**: This operation is only available if you have the following features turned on: - Orders - Single Version Subscription For information on what orders can be reverted, see Revert orders. operationId: revertOrder parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The order number of the order you wish to revert. in: path name: orderNumber required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RevertOrderRequest' required: true responses: '200': content: application/json: example: accountNumber: A00000001 orderNumber: O-00000020 status: Completed success: true subscriptionNumbers: - A-S00000001 schema: $ref: '#/components/schemas/RevertOrderResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: example: processId: processId reasons: - code: '51001122' message: '''billToContact'' may not be null' - code: '51000030' message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Revert an order tags: - Orders /v1/orders/subscription/{subscription-key}/pending: get: description: | **Note:** This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions. **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. Retrieves the detailed information about all pending orders for a specified subscription. operationId: GET_PendingOrdersBySubscriptionNumber parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Subscription number. For example, A-S00000135. in: path name: subscription-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: orders: - createdBy: 2c989028622282520162235ab0f603ba createdDate: '2018-03-14 15:12:55' currency: USD existingAccountNumber: accountA_Num invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a orderDate: '2017-01-01' orderNumber: O-00000001 status: Pending subscriptions: - baseVersion: null customFields: sub_cf_picklist__c: sub123 newVersion: 1 orderActions: - createSubscription: subscribeToRatePlans: - chargeOverrides: - chargeNumber: C-00000001 pricing: recurringVolume: listPriceBase: Per_Billing_Period quantity: 12 tiers: [] productRateplanChargeId: 2c989028622282520162235aca7a05b9 customFields: {} newRatePlanId: 2c989028622282520162235acd1b05d2 productRatePlanId: 2c989028622282520162235ac91605b3 subscriptionOwnerAccountNumber: accountA_Num terms: autoRenew: false initialTerm: period: 12 periodType: Month startDate: '2017-01-01' termType: TERMED renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerms: - period: 0 periodType: Month customFields: order_cf_date__c: '2017-01-01' sequence: 0 triggerDates: - name: ContractEffective triggerDate: '2017-01-01' - name: ServiceActivation triggerDate: '2017-01-01' type: CreateSubscription subscriptionNumber: A-S00000001 success: true updatedBy: 2c989028622282520162235ab0f603ba updatedDate: '2018-03-14 15:12:55' schema: $ref: '#/components/schemas/GetAllOrdersResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List pending orders by subscription number tags: - Orders /v1/orderActions/{id}: put: description: Updates the change reason and custom fields for an order action. operationId: PUT_OrderActions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The id of the Order Action to update. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTOrderActionsRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update an order action tags: - Order Actions /v1/order-line-items/{itemId}: get: description: | **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. If you are a new customer who onboard on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/). If you are an existing [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) customer and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/). Retrieves the detailed information about a specified order line item. The following tutorial demonstrates how to use this operation: * [View details of an order line item](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/GJ_View_details_of_an_order_line_item) operationId: GET_OrderLineItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The id of the Order Line Item to retrieve. in: path name: itemId required: true schema: format: UUID type: string - description: | Return the related fulfillments or not. in: query name: fulfillment required: false schema: default: false type: boolean responses: '200': content: application/json: examples: response: value: orderLineItem: UOM: null accountingCode: null amount: 10000 amountPerUnit: 5000 amountWithoutTax: 10000 billTargetDate: null billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa billToSnapshotId: 4028fc8487c0a43c0187c12a91500060 customFields: externalNumber5__c: olinumber-023 description: With Dual Stereo Microphones, HD 1080p, Black,USB connectivity for ease of use. id: 4028fc827a0e48c1017a0e4dccc60002 invoiceGroupNumber: N-0001 invoiceOwnerAccountId: ff80808187ff38570187ff433cbd38ef invoiceOwnerAccountName: AC_AC_16836148090011683614809001 invoiceOwnerAccountNumber: AN_1683614809001 itemName: webcam itemNumber: '1' itemState: Executing itemType: Product listPrice: 118 listPricePerUnit: 59 orderId: 4028fc827a0e48c1017a0e58b9330014 ownerAccountId: ff80808187ff38570187ff433f974203 ownerAccountName: AC_AC_16836148099861683614809986 ownerAccountNumber: AN_1683614809986 productCode: C9201 productRatePlanChargeId: null purchaseOrderNumber: 960-000764 quantity: 2 relatedSubscriptionNumber: Warranty-00002 soldTo: 4028fc828244a0ac018244dfc9a90bee soldToSnapshotId: 4028fc828244a0ac018244dfc9b00bf0 transactionDate: '2021-02-01' success: true schema: $ref: '#/components/schemas/GetOrderLineItemResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve an order line item tags: - Order Line Items put: description: | **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. If you are a new customer who onboard on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/). If you are an existing [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) customer and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/). Updates a specified order line item. The following tutorials demonstrate how to use this operation: * [Update an order line item](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/GH_Update_an_order_line_item) * [Cancel an order line item](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/GZ_Cancel_an_order_line_item) operationId: PUT_OrderLineItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The id of the Order Line Item to update. in: path name: itemId required: true schema: format: UUID type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTOrderLineItemRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/PutOrderLineItemResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update an order line item tags: - Order Line Items /v1/order-line-items/bulk: post: description: | **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. If you are a new customer who onboard on [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/). If you are an existing [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) customer and want to enable the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature, submit a request at [Zuora Global Support](https://support.zuora.com/). Bulk-updates multiple order line items. You can also choose to generate an invoice for these updated order line items. The maximum number of order line items allowable to update in a call is 100. operationId: Post_OrderLineItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostOrderLineItemsRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetOrderLineItemResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update order line items tags: - Order Line Items /v1/fulfillments: post: description: | Creates one or multiple Fulfillment objects. You can also generate invoices or memos for these Fulfillment objects in this API call. The following tutorials demonstrate how to use this operation: * [Create a sales order line item with fulfillments](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AD_Create_a_sales_order_line_item_with_fulfillments) * [Create a return order line item with fulfillments](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/Create_a_return_order_line_item_with_fulfillments) operationId: Create_Fulfillment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostFulfillmentsRequestType' required: true responses: '200': content: application/json: examples: response: value: creditMemoNumbers: null fulfillments: - fulfillmentNumber: F-00000001 id: 4028828c82819b740182821bb3b415c6 - fulfillmentNumber: F-00000002 id: 4028828c82819b740182821bb3bc15c7 invoiceNumbers: - INV00000001 paidAmount: 100 paymentNumber: P-00000001 success: true schema: $ref: '#/components/schemas/PostFulfillmentsResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create fulfillments tags: - Fulfillments /v1/fulfillments/{key}: delete: description: | Deletes a specified fulfillment. A fulfillment can only be deleted when it is in the `Executing` state. operationId: Delete_Fulfillment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The id or fulfillment number of the Fulfillment to delete. in: path name: key required: true schema: format: UUID type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a fulfillment tags: - Fulfillments get: description: | Retrieves the detailed information about a specified fulfillment. The following tutorial demonstrates how to use this operation: * [View details of a fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/H_View_details_of_a_fulfillment) operationId: GET_Fulfillment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The id or fulfillment number of the Fulfillment to retrieve. in: path name: key required: true schema: format: UUID type: string - description: Return the related fulfillment items or not. in: query name: fulfillment-items required: false schema: default: false type: boolean responses: '200': content: application/json: examples: response: value: fulfillment: billTargetDate: '2022-01-01' carrier: carrier customFields: priority__c: Hight description: description externalId: 9dc1a064-b5d1-4d7b-bd0b-ca26a1be8e01 fulfillmentDate: '2022-01-01' fulfillmentItems: - customFields: category__c: Old description: description fulfillmentId: 4028828c82819b74018281a69d3f0d93 id: 4028828c82819b74018281a69d680d98 itemIdentifier: 87309cf0-10c7-4130-8da2-439c96daa1ff fulfillmentLocation: location fulfillmentNumber: F-00000001 fulfillmentSystem: fulfillment system fulfillmentType: Delivery id: 4028828c82819b74018281a69d3f0d93 orderLineItemId: 4028828c82819b74018281a69adf0d4e quantity: 1 state: SentToBilling trackingNumber: T-00091912 success: true schema: $ref: '#/components/schemas/GetFulfillmentResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a fulfillment tags: - Fulfillments put: description: | Updates a specified fulfillment. The `state` field of a fulfillment can only be updated when it is in a different state, to trigger the state transition. The other fields of a fulfillment can only be updated when the fulfillment is in the `Executing` state, or when the fulfillment is in the `Booked` state and the user has the "Allow Edit Of Booked Order Line Items" permission. The following tutorial demonstrates how to use this operation: * [Update or cancel a fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/H_Update_a_fulfillment) operationId: PUT_Fulfillment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The id or fulfillment number of the Fulfillment to update. in: path name: key required: true schema: format: UUID type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PutFulfillmentRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a fulfillment tags: - Fulfillments /v1/fulfillment-items: post: description: | Creates one or multiple fulfillment items. operationId: Create_FulfillmentItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostFulfillmentItemsRequestType' required: true responses: '200': content: application/json: examples: response: value: fulfillmentItems: - id: 4028828c82819b74018282544fea17c6 - id: 4028828c82819b7401828254507a17c7 success: true schema: $ref: '#/components/schemas/PostFulfillmentItemsResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create fulfillment items tags: - Fulfillments /v1/fulfillment-items/{id}: delete: description: | Deletes a specified fulfillment item. operationId: Delete_FulfillmentItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The id of the Fulfillment Item to delete. in: path name: id required: true schema: format: UUID type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a fulfillment item tags: - Fulfillments get: description: | Retrieves the detailed information about a specified fulfillment item. operationId: GET_FulfillmentItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The id of the Fulfillment Item to retrieve. in: path name: id required: true schema: format: UUID type: string responses: '200': content: application/json: examples: response: value: fulfillmentItem: customFields: PICKLIST_CF__c: option_2 description: item description fulfillmentId: 4028828c82819b74018282572f6719b4 id: 4028828c82819b7401828257303a19b6 itemIdentifier: 5da7a054-24c6-4f29-866b-2c570d844fd0 success: true schema: $ref: '#/components/schemas/GetFulfillmentItemResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a fulfillment item tags: - Fulfillments put: description: | Updates a specified fulfillment item. operationId: PUT_FulfillmentItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The id of the Fulfillment Item to update. in: path name: id required: true schema: format: UUID type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PutFulfillmentItemRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a fulfillment item tags: - Fulfillments /v1/ramps/{rampNumber}: get: description: | **Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020. Retrieves the latest definition of a specified ramp. operationId: GET_RampByRampNumber parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The automatically generated number of a ramp. For example, R-00000268. in: path name: rampNumber required: true schema: type: string responses: '200': content: application/json: examples: response: value: ramp: charges: - chargeNumber: C-00000202 description: '' id: 40289f7b7321f5ce0173229d798300cf intervals: - description: '' endDate: '2020-12-31' name: Year 1 startDate: '2020-01-01' - description: '' endDate: '2021-12-31' name: Year 2 startDate: '2021-01-01' name: Two Years Ramp number: R-00000268 subscriptionNumber: A-S00000287 success: true schema: $ref: '#/components/schemas/GETRampByRampNumberResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a ramp tags: - Ramps /v1/ramps/{rampNumber}/ramp-metrics: get: description: | **Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020. Retrieves key metrics about a specified ramp, including the following metrics: * TCB, TCV in the Ramp level * TCB, TCV in the Interval level * TCB, TCV, Quantity, and MRR in Interval Metrics * Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta Metrics See [Key metrics for Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/F_Key_metrics_for_Ramps) for more information. operationId: GET_RampMetricsByRampNumber parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The automatically generated number of a ramp. For example, R-00000268. in: path name: rampNumber required: true schema: type: string responses: '200': content: application/json: examples: response: value: rampMetrics: description: '' discountTcb: 0 discountTcv: 0 grossTcb: 240 grossTcv: 240 intervals: - description: '' discountTcb: 0 discountTcv: 0 endDate: '2020-12-31' grossTcb: 120 grossTcv: 120 intervalMetrics: - chargeNumber: C-00000202 discountTcb: 0 discountTcv: 0 endDate: '2020-12-31' grossTcb: 120 grossTcv: 120 mrr: - discount: 0 endDate: '2020-12-31' gross: 10 net: 10 startDate: '2020-01-01' netTcb: 120 netTcv: 120 productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd quantity: 1 ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8 startDate: '2020-01-01' subscriptionNumber: A-S00000287 name: Year 1 netTcb: 120 netTcv: 120 startDate: '2020-01-01' - description: '' discountTcb: 0 discountTcv: 0 endDate: '2021-12-31' grossTcb: 120 grossTcv: 120 intervalMetrics: - chargeNumber: C-00000202 discountTcb: 0 discountTcv: 0 endDate: '2021-12-31' grossTcb: 120 grossTcv: 120 mrr: - discount: 0 endDate: '2021-12-31' gross: 10 net: 10 startDate: '2021-01-01' netTcb: 120 netTcv: 120 productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd quantity: 1 ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8 startDate: '2021-01-01' subscriptionNumber: A-S00000287 name: Year 2 netTcb: 120 netTcv: 120 startDate: '2021-01-01' name: Two Years Ramp netTcb: 240 netTcv: 240 number: R-00000268 success: true schema: $ref: '#/components/schemas/GETRampMetricsByRampNumberResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all ramp metrics of a ramp tags: - Ramps /v1/subscriptions/{subscriptionKey}/ramps: get: description: | **Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020. Retrieves the definition of the ramp associated with a specified subscription. operationId: GET_RampsBySubscriptionKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of an existing subscription. in: path name: subscriptionKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: ramps: - charges: - chargeNumber: C-00000202 description: '' id: 40289f7b7321f5ce0173229d798300cf intervals: - description: '' endDate: '2020-12-31' name: Year 1 startDate: '2020-01-01' - description: '' endDate: '2021-12-31' name: Year 2 startDate: '2021-01-01' name: Two Years Ramp number: R-00000268 subscriptionNumber: A-S00000287 success: true schema: $ref: '#/components/schemas/GETRampsBySubscriptionKeyResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a ramp by subscription key tags: - Ramps /v1/subscriptions/{subscriptionKey}/ramp-metrics: get: description: | **Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020. Retrieves key ramp metrics about a specified subscription, including the following metrics: * TCB, TCV in the Ramp level * TCB, TCV in the Interval level * TCB, TCV, Quantity, and MRR in Interval Metrics * Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta Metrics See [Key metrics for Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/F_Key_metrics_for_Ramps) for more information. operationId: GET_RampMetricsBySubscriptionKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of an existing subscription. in: path name: subscriptionKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: rampMetrics: description: '' discountTcb: 0 discountTcv: 0 grossTcb: 240 grossTcv: 240 intervals: - description: '' discountTcb: 0 discountTcv: 0 endDate: '2020-12-31' grossTcb: 120 grossTcv: 120 intervalMetrics: - chargeNumber: C-00000202 discountTcb: 0 discountTcv: 0 endDate: '2020-12-31' grossTcb: 120 grossTcv: 120 mrr: - discount: 0 endDate: '2020-12-31' gross: 10 net: 10 startDate: '2020-01-01' netTcb: 120 netTcv: 120 productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd quantity: 1 ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8 startDate: '2020-01-01' subscriptionNumber: A-S00000287 name: Year 1 netTcb: 120 netTcv: 120 startDate: '2020-01-01' - description: '' discountTcb: 0 discountTcv: 0 endDate: '2021-12-31' grossTcb: 120 grossTcv: 120 intervalMetrics: - chargeNumber: C-00000202 discountTcb: 0 discountTcv: 0 endDate: '2021-12-31' grossTcb: 120 grossTcv: 120 mrr: - discount: 0 endDate: '2021-12-31' gross: 10 net: 10 startDate: '2021-01-01' netTcb: 120 netTcv: 120 productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd quantity: 1 ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8 startDate: '2021-01-01' subscriptionNumber: A-S00000287 name: Year 2 netTcb: 120 netTcv: 120 startDate: '2021-01-01' name: Two Years Ramp netTcb: 240 netTcv: 240 number: R-00000268 success: true schema: $ref: '#/components/schemas/GETRampMetricsBySubscriptionKeyResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List ramp metrics by subscription key tags: - Ramps /v1/orders/{orderNumber}/ramp-metrics: get: description: | **Note**: This operation is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020. Retrieves key ramp metrics about a specified order, including the following metrics: * TCB, TCV in the Ramp level * TCB, TCV in the Interval level * TCB, TCV, Quantity, and MRR in Interval Metrics * Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta Metrics See [Key metrics for Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/F_Key_metrics_for_Ramps) for more information. operationId: GET_RampMetricsByOrderNumber parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The number of the existing order. in: path name: orderNumber required: true schema: type: string responses: '200': content: application/json: examples: response: value: rampMetrics: - description: '' discountTcb: 0 discountTcv: 0 grossTcb: 240 grossTcv: 240 intervals: - description: '' discountTcb: 0 discountTcv: 0 endDate: '2020-12-31' grossTcb: 120 grossTcv: 120 intervalDeltaMetrics: - chargeNumber: C-00000204 deltaDiscountTcb: 0 deltaDiscountTcv: 0 deltaGrossTcb: 120 deltaGrossTcv: 120 deltaMrr: - discount: 0 endDate: '2020-12-31' gross: 10 net: 10 startDate: '2020-01-01' deltaNetTcb: 120 deltaNetTcv: 120 deltaQuantity: - amount: 1 endDate: '2020-12-31' startDate: '2020-01-01' productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd subscriptionNumber: A-S00000289 intervalMetrics: - chargeNumber: C-00000204 discountTcb: 0 discountTcv: 0 endDate: '2020-12-31' grossTcb: 120 grossTcv: 120 mrr: - discount: 0 endDate: '2020-12-31' gross: 10 net: 10 startDate: '2020-01-01' netTcb: 120 netTcv: 120 productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd quantity: 1 ratePlanChargeId: 40289f7b7322a15901732392a904000a startDate: '2020-01-01' subscriptionNumber: A-S00000289 name: Year 1 netTcb: 120 netTcv: 120 startDate: '2020-01-01' - description: '' discountTcb: 0 discountTcv: 0 endDate: '2021-12-31' grossTcb: 120 grossTcv: 120 intervalDeltaMetrics: - chargeNumber: C-00000204 deltaDiscountTcb: 0 deltaDiscountTcv: 0 deltaGrossTcb: 120 deltaGrossTcv: 120 deltaMrr: - discount: 0 endDate: '2021-12-31' gross: 10 net: 10 startDate: '2021-01-01' deltaNetTcb: 120 deltaNetTcv: 120 deltaQuantity: - amount: 1 endDate: '2021-12-31' startDate: '2021-01-01' productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd subscriptionNumber: A-S00000289 intervalMetrics: - chargeNumber: C-00000204 discountTcb: 0 discountTcv: 0 endDate: '2021-12-31' grossTcb: 120 grossTcv: 120 mrr: - discount: 0 endDate: '2021-12-31' gross: 10 net: 10 startDate: '2021-01-01' netTcb: 120 netTcv: 120 productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd quantity: 1 ratePlanChargeId: 40289f7b7322a15901732392a904000a startDate: '2021-01-01' subscriptionNumber: A-S00000289 name: Year 2 netTcb: 120 netTcv: 120 startDate: '2021-01-01' name: Two Years Ramp netTcb: 240 netTcv: 240 number: R-00000270 success: true schema: $ref: '#/components/schemas/GETRampMetricsByOrderNumberResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List ramp metrics by order number tags: - Ramps /v1/subscriptions/preview: post: 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 REST API reference describes how to create a new subscription in preview mode. This call does not require a valid customer account. It can be used to show potential new customers a preview of a subscription with complete details and charges before creating an account, or to let existing customers preview a subscription with all charges before committing. **Notes**: - The response of the Preview Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers. - If you have the Invoice Settlement feature enabled, we recommend that you set the `zuora-version` parameter to `207.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error is returned. - Default values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows. | | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified | | ------------- |:-------------| :-----| | customerAcceptanceDate (CA) specified | SA uses value in the request call; CA uses value in the request call| CA uses value in the request call;SA uses CE as default | | customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default | operationId: POST_PreviewSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionPreviewType' required: true responses: '200': content: application/json: examples: response: value: success: true contractedMrr: 14.99 totalContractedValue: 179.88 amount: 14.99 amountWithoutTax: 14.99 taxAmount: 0 invoiceTargetDate: '2024-07-11' documentDate: '2024-07-11' invoiceItems: - serviceStartDate: '2024-07-01' serviceEndDate: '2024-07-31' chargeAmount: 14.99 taxAmount: 0 chargeDescription: '' chargeName: Monthly Fee productName: Music Service productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38 quantity: 1 unitOfMeasure: '' schema: $ref: '#/components/schemas/POSTSubscriptionPreviewResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Preview a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/preview: post: description: | Describes how to preview an existing subscription to view information about existing and future invoices or credit memos. **Note**: The `zuora-version` parameter must be `207.0` or later. operationId: PreviewExistingSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * targetDate * includeExistingDraftDocItems * previewType * taxationItems If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned. in: header name: zuora-version required: false schema: type: string - description: Subscription number or ID in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PreviewExistingSubscriptionRequest' required: true responses: '200': content: application/json: example: invoices: - invoiceNumber: Preview Invoice amount: 10 amountWithoutTax: 10 taxAmount: 0 targetDate: '2024-02-01' status: null isFromExistingInvoice: false invoiceItems: - serviceStartDate: '2024-01-01' serviceEndDate: '2024-01-31' amountWithoutTax: 10 taxAmount: 0 chargeDescription: Recurring Flat Fee Pricing chargeName: Recurring_Flat Fee Pricing1628472350306 chargeNumber: C-0000001 productName: P_1628472348863 productRatePlanChargeId: 402881547b216168017b2884182f12e7 processingType: Charge unitPrice: 10 quantity: 1 unitOfMeasure: null creditMemos: - creditMemoNumber: Preview Credit Memo amount: 10 amountWithoutTax: 10 taxAmount: 0 targetDate: '2024-02-01' status: null isFromExistingCreditMemo: false creditMemoItems: - serviceStartDate: '2024-01-01' serviceEndDate: '2024-01-31' amountWithoutTax: 10 taxAmount: 0 chargeDescription: Recurring Flat Fee Pricing chargeName: Recurring_Flat Fee Pricing1628472350306 chargeNumber: C-0000001 productName: P_1628472348863 productRatePlanChargeId: 402881547b216168017b2884182f12e7 processingType: Charge unitPrice: 10 quantity: 1 unitOfMeasure: null success: true schema: $ref: '#/components/schemas/PreviewExistingSubscriptionResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Preview a subscription by subscription key tags: - Subscriptions x-accepts: application/json x-codegen-request-body-name: Request x-content-type: application/json /v1/subscriptions: post: description: |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 REST API reference describes how to create a new subscription for an existing customer account. ### Notes If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. Default values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows. This API operation does not support creating a pending subscription. | | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified | | ------------- |:------------- | :-----| | customerAcceptanceDate (CA) specified| SA uses value in the request call; CA uses value in the request call| CA uses value in the request call;SA uses CE as default | | customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default | operationId: POST_Subscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionType' required: true responses: '200': content: application/json: examples: response: value: success: true subscriptionId: 8ad087d290a5e7330190b98577936eaf subscriptionNumber: A-S00000141 contractedMrr: 14.99 totalContractedValue: 179.88 schema: $ref: '#/components/schemas/POSTSubscriptionResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a subscription tags: - Subscriptions /v1/subscriptions/accounts/{account-key}: get: description: | Retrieves all subscriptions associated with the specified account. Zuora only returns the latest version of the subscriptions. Subscription data is returned in reverse chronological order based on `updatedDate`. Note that the rate plans inside the subscriptions are not sorted specifically and are returned in a random order. operationId: GET_SubscriptionsByAccount parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | Possible values are: * an account number * an account ID in: path name: account-key required: true schema: type: string - description: | The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates. * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate). * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments. * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd. in: query name: charge-detail required: false schema: type: string - description: | If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`. in: query name: exclude-rate-plans-with-no-charges required: false schema: type: boolean - description: |2- If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response. The default value is `false`. in: query name: getDetailedMetrics schema: type: boolean default: false - description: |- The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`. The default value is the current date. in: query name: asOfDay schema: type: string responses: '200': content: application/json: examples: response: value: subscriptions: - accountId: 8a8082c45aa81b51015ad64396090f5c accountName: ABCD accountNumber: A00002641 autoRenew: true billToContact: address1: '' address2: '' city: '' country: null county: null fax: '' firstName: Test homePhone: '' id: 2c9081a03c6d7b51013c6d7e46c80a17 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' contractEffectiveDate: '2017-01-01' contractedMrr: 8.33 contractedNetMrr: 8.33 asOfDayGrossMrr: 8.33 asOfDayNetMrr: 8.33 netTotalContractedValue: 8.33 currency: USD currentTerm: 12 currentTermPeriodType: Month customerAcceptanceDate: '2017-01-01' id: 8a8082c45aa81b51015ad68743ec0fdb initialTerm: 12 initialTermPeriodType: Month invoiceGroupNumber: N-0001 invoiceOwnerAccountId: 8a8082c45aa81b51015ad64396090f5c invoiceOwnerAccountName: ABCD invoiceOwnerAccountNumber: A00002641 invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a invoiceSeparately: false invoiceTemplateId: 2c9081a03c638994013c63978baf002b invoiceTemplateName: InvoiceTemplateName notes: '' paymentTerm: Net 30 ratePlans: - id: 8a8082c45aa81b51015ad68744030fe3 productId: 8a8082c45aa81b51015ad5a2d07d0e89 productName: ABC productRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d productSku: SKU-00000987 contractedNetMrr: 8.33 contractedMrr: 8.33 asOfDayGrossMrr: 8.33 asOfDayNetMrr: 8.33 netTotalContractedValue: 8.33 ratePlanCharges: - applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Annual billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargedThroughDate: null currency: USD description: '' discountAmount: null discountApplyDetails: null discountClass: null discountLevel: null discountPercentage: null dmrc: 8.333333 done: false dtcv: 100 effectiveEndDate: '2018-01-01' effectiveStartDate: '2017-01-01' endDateCondition: Subscription_End id: 8a8082c45aa81b51015ad68744160fe4 includedUnits: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: Per_Billing_Period model: FlatFee mrr: 8.333333 name: Annual Charge number: C-00032238 numberOfPeriods: null originalChargeId: 8a8082c45aa81b51015ad68744160fe4 overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: 100 priceChangeOption: NoChange priceIncreasePercentage: null pricingSummary: USD100 processedThroughDate: null productRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f quantity: 1 segment: 1 smoothingModel: null specificBillingPeriod: null specificEndDate: null tcv: 100 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 - applyDiscountTo: ONETIMERECURRINGUSAGE billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: null chargedThroughDate: null currency: USD description: '' discountAmount: 10 discountApplyDetails: - appliedProductName: ABC appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f appliedProductRatePlanChargeName: Annual Charge appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d appliedProductRatePlanName: RatePlan 1 - appliedProductName: ABC appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f appliedProductRatePlanChargeName: Annual Charge appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d appliedProductRatePlanName: RatePlan 1 discountClass: VIP Discount discountLevel: subscription discountPercentage: null dmrc: 0 done: false dtcv: 0 effectiveEndDate: '2018-01-01' effectiveStartDate: '2017-01-01' endDateCondition: Subscription_End id: 8a8082c45aa81b51015ad68744240fe5 includedUnits: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: null model: DiscountFixedAmount mrr: 0 name: Discount-Fixed 10 number: C-00032239 numberOfPeriods: null originalChargeId: 8a8082c45aa81b51015ad68744240fe5 overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: null priceChangeOption: null priceIncreasePercentage: null pricingSummary: USD10 fixed amount discount processedThroughDate: null productRatePlanChargeId: 8a8082c45aa81b51015ad683bc590fd8 quantity: null segment: 1 smoothingModel: null specificBillingPeriod: null specificEndDate: null tcv: 0 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 - amendedByOrderOn: null applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargeModelConfiguration: null chargedThroughDate: null currency: USD description: '' discountAmount: null discountApplyDetails: null discountClass: null discountLevel: null discountPercentage: null dmrc: 38.571428571 done: false dtcv: 468 effectiveEndDate: '2026-01-01' effectiveStartDate: '2024-12-31' endDateCondition: Subscription_End id: 4028818386ba85070186bab54f99573d includedUnits: null inputArgumentId: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: Per_Billing_Period model: Delivery mrr: 38.571428571 name: Delivery Charge number: C-00032240 numberOfDeliveries: 52 numberOfPeriods: null originalChargeId: 4028818386ba85070186bab54f065731 originalOrderDate: '2023-01-01' overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: 9 priceChangeOption: null priceIncreasePercentage: null pricingSummary: '' processedThroughDate: null productRatePlanChargeId: 4028818386b61be50186b6293eb30017 quantity: 1 ratingGroup: null segment: 3 smoothingModel: null specificBillingPeriod: null specificEndDate: null subscriptionChargeDeliverySchedule: dayOfMonth: null frequency: Weekly friday: false monday: false monthOfYear: null saturday: false sunday: true thursday: false tuesday: false wednesday: false subscriptionChargeIntervalPricing: - duration: 365 price: 5 sequence: 1 subscriptionChargeIntervalPriceTiers: [] type: Day - duration: 365 price: 7 sequence: 2 subscriptionChargeIntervalPriceTiers: [] type: Day - duration: null price: 9 sequence: 3 subscriptionChargeIntervalPriceTiers: [] type: Infinity tcv: 468 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 ratePlanName: RatePlan 1 renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerm: 12 renewalTermPeriodType: Month revision: '1.0' sequenceSetId: 6abcc30846de11e990900242ac1f0003 sequenceSetName: DEFAULT serviceActivationDate: '2017-01-01' soldToContact: address1: '' address2: '' city: '' country: null county: null fax: '' firstName: Test homePhone: '' id: 2c9081a03c6d7b51013c6d7e46c80a17 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' status: Active subscriptionNumber: A-S00007412 subscriptionStartDate: '2017-01-01' termEndDate: '2018-01-01' termStartDate: '2017-01-01' termType: TERMED totalContractedValue: 100 version: 1 success: true schema: $ref: '#/components/schemas/GETSubscriptionWrapper' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List subscriptions by account key tags: - Subscriptions /v1/subscriptions/{subscription-key}: get: description: | This REST API reference describes how to retrieve detailed information about a specified subscription in the latest version. operationId: GET_SubscriptionsByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Possible values are: * a subscription number * a subscription ID in: path name: subscription-key required: true schema: type: string - description: | The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates. * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate). * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments. * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified ((specific date = effectiveStartDate) OR (effectiveStartDate < specific date < effectiveEndDate)). The format of the date is yyyy-mm-dd. in: query name: charge-detail required: false schema: type: string - description: | If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`. in: query name: exclude-rate-plans-with-no-charges required: false schema: type: boolean - description: |2- If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response. The default value is `false`. in: query name: getDetailedMetrics schema: type: boolean default: false - description: |- The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`. The default value is the current date. in: query name: asOfDay schema: type: string - description: 'Retrieves the invoice owner of a subscription. If this parameter is set to `true`, the invoice owner account details `invoiceOwnerAccountDetails` will be in the response. ' in: query name: getInvoiceOwnerDetails schema: type: boolean - description: 'Retrieves the owner of a subscription. If this parameter is set to `true`, the subscription owner account details `accountOwnerDetails` will be in the response. ' in: query name: getSubscriptionOwnerDetails schema: type: boolean responses: '200': content: application/json: examples: response: value: accountId: 8a8082c45aa81b51015ad64396090f5c accountName: ABCD accountNumber: A00002641 accountOwnerDetails: accountNumber: A00000001 batch: Batch1 communicationProfileId: 303d186840e611df817c002185d714e1 crmId: '' id: 402892c74c9193cd014c91d35b0a0132 invoiceTemplateId: null name: Test notes: '' partnerAccount: false profileNumber: CP-00000012 salesRep: '' sequenceSetId: null status: Active summaryStatementTemplateId: null purchaseOrderNumber: '' invoiceOwnerAccountDetails: accountNumber: A00000001 batch: Batch1 communicationProfileId: 303d186840e611df817c002185d714e1 crmId: '' id: 402892c74c9193cd014c91d35b0a0132 invoiceTemplateId: null name: Test notes: '' partnerAccount: false profileNumber: CP-00000012 salesRep: '' sequenceSetId: null status: Active autoRenew: true contractEffectiveDate: '2017-01-01' contractedMrr: 8.33 contractedNetMrr: 8.33 asOfDayGrossMrr: 8.33 asOfDayNetMrr: 8.33 netTotalContractedValue: 8.33 currency: USD currentTerm: 12 currentTermPeriodType: Month customerAcceptanceDate: '2017-01-01' id: 8a8082c45aa81b51015ad68743ec0fdb initialTerm: 12 initialTermPeriodType: Month invoiceGroupNumber: N-0001 invoiceOwnerAccountId: 8a8082c45aa81b51015ad64396090f5c invoiceOwnerAccountName: ABCD invoiceOwnerAccountNumber: A00002641 invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a invoiceSeparately: false invoiceTemplateId: 2c9081a03c638994013c63978baf002b invoiceTemplateName: InvoiceTemplateName notes: '' paymentTerm: Net 30 ratePlans: - id: 8a8082c45aa81b51015ad68744030fe3 productId: 8a8082c45aa81b51015ad5a2d07d0e89 productName: ABC productRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d productSku: SKU-00000987 contractedNetMrr: 8.33 contractedMrr: 8.33 asOfDayGrossMrr: 8.33 asOfDayNetMrr: 8.33 netTotalContractedValue: 8.33 ratePlanCharges: - applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Annual billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargedThroughDate: null currency: USD description: '' discountAmount: null discountApplyDetails: null discountClass: null discountLevel: null discountPercentage: null dmrc: 8.333333 done: false dtcv: 100 effectiveEndDate: '2018-01-01' effectiveStartDate: '2017-01-01' endDateCondition: Subscription_End id: 8a8082c45aa81b51015ad68744160fe4 includedUnits: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: Per_Billing_Period model: FlatFee mrr: 8.333333 name: Annual Charge number: C-00032238 numberOfPeriods: null originalChargeId: 8a8082c45aa81b51015ad68744160fe4 overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: 100 priceChangeOption: NoChange priceIncreasePercentage: null pricingSummary: USD100 processedThroughDate: null productRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f quantity: 1 segment: 1 smoothingModel: null specificBillingPeriod: null specificEndDate: null tcv: 100 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 - applyDiscountTo: ONETIMERECURRINGUSAGE billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: null chargedThroughDate: null currency: USD description: '' discountAmount: 10 discountApplyDetails: - appliedProductName: ABC appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f appliedProductRatePlanChargeName: Annual Charge appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d appliedProductRatePlanName: RatePlan 1 discountClass: VIP Discount discountLevel: subscription discountPercentage: null dmrc: 0 done: false dtcv: 0 effectiveEndDate: '2018-01-01' effectiveStartDate: '2017-01-01' endDateCondition: Subscription_End id: 8a8082c45aa81b51015ad68744240fe5 includedUnits: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: null model: DiscountFixedAmount mrr: 0 name: Discount-Fixed 10 number: C-00032239 numberOfPeriods: null originalChargeId: 8a8082c45aa81b51015ad68744240fe5 overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: null priceChangeOption: null priceIncreasePercentage: null pricingSummary: USD10 fixed amount discount processedThroughDate: null productRatePlanChargeId: 8a8082c45aa81b51015ad683bc590fd8 quantity: null segment: 1 smoothingModel: null specificBillingPeriod: null specificEndDate: null tcv: 0 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 - amendedByOrderOn: null applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargeModelConfiguration: null chargedThroughDate: null currency: USD description: '' discountAmount: null discountApplyDetails: null discountClass: null discountLevel: null discountPercentage: null dmrc: 38.571428571 done: false dtcv: 468 effectiveEndDate: '2026-01-01' effectiveStartDate: '2024-12-31' endDateCondition: Subscription_End id: 4028818386ba85070186bab54f99573d includedUnits: null inputArgumentId: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: Per_Billing_Period model: Delivery mrr: 38.571428571 name: Delivery Charge number: C-00032240 numberOfDeliveries: 52 numberOfPeriods: null originalChargeId: 4028818386ba85070186bab54f065731 originalOrderDate: '2023-01-01' overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: 9 priceChangeOption: null priceIncreasePercentage: null pricingSummary: '' processedThroughDate: null productRatePlanChargeId: 4028818386b61be50186b6293eb30017 quantity: 1 ratingGroup: null segment: 3 smoothingModel: null specificBillingPeriod: null specificEndDate: null subscriptionChargeDeliverySchedule: dayOfMonth: null frequency: Weekly friday: false monday: false monthOfYear: null saturday: false sunday: true thursday: false tuesday: false wednesday: false subscriptionChargeIntervalPricing: - duration: 365 price: 5 sequence: 1 subscriptionChargeIntervalPriceTiers: [] type: Day - duration: 365 price: 7 sequence: 2 subscriptionChargeIntervalPriceTiers: [] type: Day - duration: null price: 9 sequence: 3 subscriptionChargeIntervalPriceTiers: [] type: Infinity tcv: 468 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 ratePlanName: RatePlan 1 renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerm: 12 renewalTermPeriodType: Month revision: '1.0' sequenceSetId: 6abcc30846de11e990900242ac1f0003 sequenceSetName: DEFAULT serviceActivationDate: '2017-01-01' billToContact: address1: '' address2: '' city: '' country: null county: null fax: '' firstName: Test homePhone: '' id: 2c9081a03c6d7b51013c6d7e46c80a17 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' soldToContact: address1: '' address2: '' city: '' country: null county: null fax: '' firstName: Test homePhone: '' id: 2c9081a03c6d7b51013c6d7e46c80a17 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' status: Active subscriptionNumber: A-S00007412 subscriptionStartDate: '2017-01-01' success: true termEndDate: '2018-01-01' termStartDate: '2017-01-01' termType: TERMED totalContractedValue: 100 version: 1 schema: $ref: '#/components/schemas/GETSubscriptionByKeyWithSuccess' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a subscription by key tags: - Subscriptions put: description: | Use this call to make the following kinds of changes to a subscription: - Add a note - Change the renewal term or auto-renewal flag - Change the term length or change between evergreen and termed - Add a new product rate plan - Remove an existing subscription rate plan - Change the quantity or price of an existing subscription rate plan - Change rate plans - to replace the existing rate plans in a subscription with other rate plans. Changing rate plans is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, changing rate plans will no longer be applicable in Zuora Billing. ### Notes: - The "Update a subscription" call creates a new subscription object that has a new version number and to which the subscription changes are applied. The new subscription object has the same subscription name but a new, different, subscription ID. The `Status` field of the new subscription object will be set to `Active` unless the change applied was a cancelation or suspension in which case the status reflects that. The `Status` field of the originating subscription object changes from `Active` to `Expired`. A status of `Expired` does not imply that the subscription itself has expired or ended, merely that this subscription object is no longer the most recent. - In one request, this call can make: - Up to 9 combined add, update, and remove changes - No more than 1 change to terms & conditions - Updates are performed in the following sequence: 1. First change the notes on the existing subscription, if requested. 2. Then change the terms and conditions, if requested. 3. Then perform the remaining amendments based upon the effective dates specified. If multiple amendments have the same contract-effective dates, then execute adds before updates, and updates before removes. - The update operation is atomic. If any of the updates fails, the entire operation is rolled back. - The response of the Update Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers. - If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. ### Override a Tiered Price There are two ways you override a tiered price: - Override a specific tier number. For example: `tiers[{tier:1,price:8},{tier:2,price:6}]` - Override the entire tier structure. For example: `tiers[{tier:1,price:8,startingUnit:1,endingUnit:100,priceFormat:"FlatFee"}, {tier:2,price:6,startingUnit:101,priceFormat:"FlatFee"}]` If you just override a specific tier, do not include the `startingUnit` field in the request. operationId: PUT_Subscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - description: | Subscription number or ID. ID can be the latest version or any history version of ID. * To make sure you update the last version of the subscription, use one of the following operations to retrieve the last version of ID: * [List subscriptions by account key](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByAccount) * [Retrieve a subscription by key](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByKey) by using the subscription number as the subscription-key * If you want to use any history version of ID, the `STABLE_ID_PUBLIC_API` permission must be enabled. Submit a request at [Zuora Global Support](http://support.zuora.com/) to enable the permission. To retrieve a history version of ID, use the [Retrieve a subscription by key and version](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByKeyAndVersion) operation. in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionType' required: true responses: '200': content: application/json: examples: response: value: subscriptionId: 4028bb83510f8ed7015114a503cf0373 success: true totalDeltaMrr: 100 totalDeltaTcv: 4867.7419355 schema: $ref: '#/components/schemas/PUTSubscriptionResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/versions/{version}: get: description: | This REST API reference describes how to retrieve detailed information about a specified subscription in a specified version. When you create a subscription amendment, you create a new version of the subscription. You can use this method to retrieve information about a subscription in any version. operationId: GET_SubscriptionsByKeyAndVersion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Subscription number. For example, A-S00000135. in: path name: subscription-key required: true schema: type: string - description: | Subscription version. For example, 1. in: path name: version required: true schema: type: string - description: | The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates. * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate). * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments. * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd. in: query name: charge-detail required: false schema: type: string - description: | If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`. in: query name: exclude-rate-plans-with-no-charges required: false schema: type: boolean - description: |2- If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response. The default value is `false`. in: query name: getDetailedMetrics schema: type: boolean default: false - description: |- The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`. The default value is the current date. in: query name: asOfDay schema: type: string responses: '200': content: application/json: examples: response: value: accountId: 2c9081a03c63c94c013c66688a2c00bf accountName: RestAPI accountNumber: RestAPI autoRenew: false contractEffectiveDate: '2012-02-01' contractedMrr: 26.67 contractedNetMrr: 26.67 asOfDayGrossMrr: 26.67 asOfDayNetMrr: 26.67 netTotalContractedValue: 26.67 currency: USD currentTerm: 12 currentTermPeriodType: Week customerAcceptanceDate: '2012-02-01' id: 2c9081a03c63c94c013c687b864e0195 initialTermPeriodType: Week invoiceGroupNumber: N-0001 invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a notes: '' ratePlans: - id: 2c9081a03c63c94c013c687b868901a4 productId: 2c9081a03c63c94c013c66499ef0001b productName: OneTime productRatePlanId: 2c9081a03c63c94c013c665102e5003a productSku: SKU-00000022 contractedNetMrr: 26.67 contractedMrr: 26.67 asOfDayGrossMrr: 26.67 asOfDayNetMrr: 26.67 netTotalContractedValue: 26.67 ratePlanCharges: - applyDiscountTo: null billingDay: null billingPeriod: null billingPeriodAlignment: null billingTiming: null chargedThroughDate: '2012-02-02' currency: USD description: '' discountAmount: null discountLevel: null discountPercentage: null dmrc: null done: true dtcv: 24 effectiveEndDate: '2012-02-02' effectiveStartDate: '2012-02-01' endDateCondition: One_Time id: 2c9081a03c63c94c013c687b868901a5 includedUnits: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: null model: Tiered mrr: null name: OT_Tiered number: C-00000010 numberOfPeriods: null originalChargeId: 2c9081a03c63c94c013c687a92d70175 overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: null priceChangeOption: null priceIncreasePercentage: null pricingSummary: '0 to 10 Each: USD20 flat fee; 11 Each or more: USD4/Each' processedThroughDate: '2012-02-02' productRatePlanChargeId: 2c9081a03c63c94c013c6651d677003c quantity: 11 segment: 1 smoothingModel: null specificBillingPeriod: null specificEndDate: null tcv: 24 tiers: - endingUnit: 10 price: 20 priceFormat: FlatFee startingUnit: 0 tier: 1 - endingUnit: null price: 4 priceFormat: PerUnit startingUnit: 11 tier: 2 triggerDate: null triggerEvent: ContractEffective type: OneTime unusedUnitsCreditRates: null uom: Each upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 ratePlanName: OT_Tiered renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerm: 0 renewalTermPeriodType: Week revision: '1.0' serviceActivationDate: '2012-02-01' status: Active subscriptionNumber: A-S00000004 subscriptionStartDate: '2012-02-01' success: true termEndDate: '2013-02-01' termStartDate: '2012-02-01' termType: TERMED totalContractedValue: 404 version: 1 schema: $ref: '#/components/schemas/GETSubscriptionTypeWithSuccess' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a subscription by key and version tags: - Subscriptions /v1/subscriptions/{subscription-key}/renew: put: description: | Renews a termed subscription using existing renewal terms. When you renew a subscription, the current subscription term is extended by creating a new term. If any charge in your subscription has the billing period set as `SubscriptionTerm`, a new charge segment is generated for the new term. **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. operationId: PUT_RenewSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - description: Subscription number or ID in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTRenewSubscriptionType' required: true responses: '200': content: application/json: examples: response: value: subscriptionId: 2c92c8f83dcbd8b1013dcce0f09100a5 success: true termEndDate: '2014-05-01' termStartDate: '2014-02-01' schema: $ref: '#/components/schemas/PUTRenewSubscriptionResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Renew a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/cancel: put: description: | This REST API reference describes how to cancel an active subscription. **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. operationId: PUT_CancelSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - description: Subscription number or ID. Subscription status must be `Active`. in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionCancellationType' required: true responses: '200': content: application/json: examples: response: value: cancelledDate: '2019-05-31' invoiceId: 8a8082c453cd2a620153e426c7eb78b3 subscriptionId: 8a8082c453cd2a620154efc7bba0350e success: true totalDeltaMrr: 0 totalDeltaTcv: -703.2258065 schema: $ref: '#/components/schemas/POSTSubscriptionCancellationResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Cancel a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/resume: put: description: | This REST API reference describes how to resume a suspended subscription. **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. operationId: PUT_ResumeSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - description: Subscription number or ID. Subscription status must be Suspended. in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionResumeType' required: true responses: '200': content: application/json: examples: response: value: resumeDate: '2019-10-01' subscriptionId: 8a8082c4539c5bcc0153a752f9c87094 success: true termEndDate: '2020-01-31' totalDeltaTcv: 396.7741935 schema: $ref: '#/components/schemas/PUTSubscriptionResumeResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Resume a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/suspend: put: description: | This REST API reference describes how to suspend an active subscription. **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `zuora-version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. operationId: PUT_SuspendSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - description: Subscription number or ID. Subscription status must be Active. in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionSuspendType' required: true responses: '200': content: application/json: examples: response: value: success: true subscriptionId: 8ad0937890e7fca00190fd3ff7ca7f08 suspendDate: '2024-07-28' resumeDate: null termEndDate: '2025-07-22' totalDeltaTcv: -176.978709679 schema: $ref: '#/components/schemas/PUTSubscriptionSuspendResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Suspend a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/delete: put: 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 REST API reference describes how to delete a subscription of the specified subscription number. operationId: PUT_DeleteSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Subscription number in: path name: subscription-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/PUTDeleteSubscriptionResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a subscription by number tags: - Subscriptions /v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields: put: 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.
Updates the custom fields of a specified subscription version. operationId: PUT_UpdateSubscriptionCustomFieldsOfASpecifiedVersion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The subscription number to be updated. in: path name: subscriptionNumber required: true schema: format: string type: string - description: The subscription version to be updated. in: path name: version required: true schema: format: string type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionPatchSpecificVersionRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update subscription custom fields of a subscription version tags: - Subscriptions /v1/subscriptions/subscription-metrics: get: description: | Lists subscription metrics for the subscriptions that you specify by subscription numbers. operationId: GetMetricsBySubscriptionNumbers parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The date for the metrics. The date should be in the format `YYYY-MM-DD`. The default value is the current date. in: query name: asOfDay schema: type: string - description: The subscription numbers of existing subscriptions. in: query name: subscriptionNumbers[] required: true schema: type: array items: type: string responses: '200': content: application/json: example: subscriptionMetrics: - subscriptionNumber: A-S00000008 contractedMrr: 100 contractedNetMrr: 100 asOfDayGrossMrr: 100 asOfDayNetMrr: 100 netTotalContractedValue: 100 totalContractedValue: 100 - subscriptionNumber: A-S00000009 contractedMrr: 100 contractedNetMrr: 100 asOfDayGrossMrr: 100 asOfDayNetMrr: 100 netTotalContractedValue: 100 totalContractedValue: 100 success: true schema: $ref: '#/components/schemas/GETMetricsBySubscriptionNumbersResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '400': content: application/json: example: processId: processId reasons: - code: '51001122' message: '''billToContact'' may not be null' - code: '51000030' message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List subscriptions metrics by subscription numbers tags: - Subscriptions /v1/rateplans/{ratePlanId}: get: description: | Retrieves the detailed information about a specific subscription rate plan. * If you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled, this operation retrieves information about a subscription rate plan and the related order that has amended the rate plan. * If you have the [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) feature enabled, this operation retrieves information about a subscription rate plan and the related order and amendment that have amended the rate plan. * If you are an existing Zuora Subscribe and Amend customer, this operation retrieves information about a subscription rate plan and the related amendment that has amended the rate plan. **Note:** Orders is now generally available as of Zuora Billing Release 284 (August 2020). If you are an existing Zuora Subscribe and Amend customer and want to adopt Orders, see [What is Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization#What_is_Orders_Harmonization.3F) and join the [Orders Harmonization community group](https://community.zuora.com/t5/Orders-Harmonization/gp-p/Orders-Harmonization) for more information. If you want to enable Orders, submit a request at [Zuora Global Support](https://support.zuora.com/). **Note:** You can only retrieve information about the following order actions: * `addProduct` * `updateProduct` * `removeProduct` * `changePlan` operationId: GET_RatePlan parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the subscription rate plan to be retrieved. in: path name: ratePlanId required: true schema: format: string type: string responses: '200': content: application/json: examples: response: value: amendment: code: A-AM00000047 contractEffectiveDate: '2021-12-29' createdBy: 2c9890207c9649c0017c969bc6330002 createdDate: '2021-10-29 19:44:16' customerAcceptanceDate: '2021-12-29' description: null effectiveDate: '2021-12-29' id: 402880e47ccbaca1017ccbdd63c818cb name: update serviceActivationDate: '2021-12-29' type: UpdateProduct updatedBy: 2c9890207c9649c0017c969bc6330002 updatedDate: '2021-10-29 19:44:16' id: 402880e47ccbaca1017ccbdd63aa18c8 lastChangeType: Update order: id: 402880e47ccbaca1017ccbdd7b0e18fd orderActions: - contractEffectiveDate: '2021-12-29' customerAcceptanceDate: '2021-12-29' id: 402880e47ccbaca1017ccbdd7b1418ff serviceActivationDate: '2021-12-29' type: UpdateProduct updateProduct: chargeUpdates: [] customFields: {} newRatePlanId: 402880e47ccbaca1017ccbdd63aa18c8 productRatePlanId: 2c9890207c9649c0017c96a0f11001a4 ratePlanId: 402880e47ccbaca1017ccbdd620818ba specificUpdateDate: null uniqueToken: null orderNumber: O-00000037 productId: 2c9890207c9649c0017c96a0588201a2 productName: MMORPG game productRatePlanId: 2c9890207c9649c0017c96a0f11001a4 productSku: SKU-00000001 ratePlanName: Rate Plan 1 subscriptionId: 402880e47ccbaca1017ccbdd644d18d0 subscriptionVersion: 5 success: true schema: $ref: '#/components/schemas/GetOrderActionRatePlanResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a rate plan tags: - Rate Plans /v1/omni-channel-subscriptions: post: description: | Creates or updates an omnichannel subscription for a customer account. You can also create a new customer account and assign it to the new omnichannel subscription. operationId: postOmnichannelSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOmniChannelSubscriptionRequest' required: true responses: '200': content: application/json: example: success: true subscriptionId: 54be52bbb1b9288bbf82942e00de0000 subscriptionNumber: A-S00000001 accountId: 2c98906e9288bc0b0192942dfbdc316d accountNumber: AN_1729062894303 schema: $ref: '#/components/schemas/CreateOmniChannelSubscriptionResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: example: processId: processId reasons: - code: '51001122' message: '''billToContact'' may not be null' - code: '51000030' message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create an omnichannel subscription tags: - Omnichannel Subscriptions /v1/omni-channel-subscriptions/{subscriptionKey}: get: description: 'Retrieves the information about a specific omnichannel subscription. ' operationId: getOmnichannelSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_get_account_details' - description: The ID or number of the omnichannel subscription to be retrieved. The ID may be a Zuora subscription ID or an external system subscription ID. in: path name: subscriptionKey required: true schema: type: string responses: '200': content: application/json: example: success: true id: 303d186840e611df817c002185d714e1 subscriptionNumber: A-S00000001 externalSubscriptionId: 56cc93ed3767476782cf2f150e38249c accountId: 2c98906e9288bc0b0192942dfbdc316d externalTransactionReason: Purchase externalSourceSystem: Apple externalState: Grace state: Active externalProductId: 874d2a0ef3ad43d5b3402771f56aca1d externalReplaceByProductId: null externalInAppOwnershipType: Purchase externalQuantity: 1 currency: USD autoRenew: false originalPurchaseDate: '2024-02-01 00:01:15' externalPurchaseDate: '2024-03-05 10:42:11' externalActivationDate: '2024-03-01 12:12:12' externalExpirationDate: '2024-06-01 12:12:12' externalApplicationId: external-application-id externalBundleId: external-bundle-id externalSubscriberId: external-subscriber-id externalPrice: 100 externalPurchaseType: Purchase externalLastRenewalDate: '2024-03-01 12:12:12' externalNextRenewalDate: '2024-09-01 12:12:12' schema: $ref: '#/components/schemas/GetOmniChannelSubscriptionResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: example: processId: processId reasons: - code: '51001122' message: '''billToContact'' may not be null' - code: '51000030' message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve an omnichannel subscription tags: - Omnichannel Subscriptions delete: description: 'Deletes a specified omnichannel subscription. ' operationId: deleteOmnichannelSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The key of the omnichannel subscription to be deleted. in: path name: subscriptionKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: example: processId: processId reasons: - code: '51001122' message: '''billToContact'' may not be null' - code: '51000030' message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete an omnichannel subscription tags: - Omnichannel Subscriptions /v1/subscription-change-logs/{subscriptionNumber}: get: description: | Lists subscription change histories of a single version subscription. Each history maps to an order. See the `subscriptions` > `fields`, `ratePlans` > `fields`, and `ratePlanCharges` > `fields` fields for the changes in the subscription, subscription rate plans, and subscription rate plan charges. **Note**: This operation is only available if you have the following features turned on: - Orders - Single Version Subscription operationId: getSubscriptionChangeLogsBySubscriptionNumber parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The subscription number to be retrieved. in: path name: subscriptionNumber required: true schema: type: string responses: '200': content: application/json: example: success: true subscriptions: - subscriptionNumber: A-S00000001 version: 2 subscriptionStartDate: '2021-01-01' subscriptionEndDate: '2023-02-01' termStartDate: '2021-02-01' termEndDate: '2023-02-01' accountNumber: AN_1723454733315 invoiceOwnerAccountNumber: AN_1723454733315 currency: USD orderNumber: O-00000002 type: Standard externalSubscriptionId: null changedTime: '2024-08-12 02:25:36' ratePlans: - ratePlanNumber: SRP-00000001 ratePlanCharges: - chargeNumber: C-00000001 ratePlanChargeId: 28b907304229145dff3145e84432000a effectiveStartDate: '2021-01-01' effectiveEndDate: '2023-02-01' fields: - fieldName: effectiveEndDate oldValue: '2022-01-01' newValue: '2023-02-01' fields: [] fields: - fieldName: initialTerm oldValue: '12' newValue: '2' - fieldName: initialTermPeriodType oldValue: Month newValue: Year - subscriptionNumber: A-S00000001 version: 1 subscriptionStartDate: '2021-01-01' subscriptionEndDate: '2022-01-01' termStartDate: '2021-01-01' termEndDate: '2022-01-01' accountNumber: AN_1723454733315 invoiceOwnerAccountNumber: AN_1723454733315 currency: USD orderNumber: O-00000001 type: Standard externalSubscriptionId: null changedTime: '2024-08-12 02:25:35' ratePlans: - ratePlanNumber: SRP-00000001 ratePlanCharges: - chargeNumber: C-00000001 ratePlanChargeId: 28b907304229145dff3145e84432000a effectiveStartDate: '2021-01-01' effectiveEndDate: '2022-01-01' fields: - fieldName: price oldValue: null newValue: '100' - fieldName: quantity oldValue: null newValue: '1' fields: - fieldName: RP_CF1__c oldValue: null newValue: Init value for rp cf 1 fields: - fieldName: accountId oldValue: null newValue: ff8080819145e003019145e83c4657cb - fieldName: autoRenew oldValue: null newValue: 'false' schema: $ref: '#/components/schemas/GetSubscriptionChangeLogsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: example: processId: processId reasons: - code: '51001122' message: '''billToContact'' may not be null' - code: '51000030' message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List change histories of a subscription tags: - Subscription Change History /v1/subscription-change-logs/orders/{orderNumber}: get: description: | List the change histories of single version subscriptions that are included in and processed by an order. Each history maps to a subscription associated with this order. See the `subscriptions` > `fields`, `ratePlans` > `fields`, and `ratePlanCharges` > `fields` fields for the changes in the subscription, subscription rate plans, and subscription rate plan charges. **Note**: This operation is only available if you have the following features turned on: - Orders - Single Version Subscription operationId: getSubscriptionChangeLogsByOrderNumber parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The order number associated with the subscription to be retrieved. in: path name: orderNumber required: true schema: type: string responses: '200': content: application/json: example: success: true subscriptions: - subscriptionNumber: A-S00000001 version: 1 subscriptionStartDate: '2021-01-01' subscriptionEndDate: '2022-01-01' termStartDate: '2021-01-01' termEndDate: '2022-01-01' accountNumber: AN_1723456739867 invoiceOwnerAccountNumber: AN_1723456739867 currency: USD orderNumber: O-00000001 type: Standard externalSubscriptionId: null changedTime: '2024-08-12 02:59:00' ratePlans: - ratePlanNumber: SRP-00000001 ratePlanCharges: - chargeNumber: C-00000001 ratePlanChargeId: 240207304399145dff314606db890009 effectiveStartDate: '2021-01-01' effectiveEndDate: '2022-01-01' fields: - fieldName: price oldValue: null newValue: '100' - fieldName: quantity oldValue: null newValue: '1' fields: [] fields: - fieldName: accountId oldValue: null newValue: ff8080819145e00301914606da4c613f - fieldName: autoRenew oldValue: null newValue: 'false' - subscriptionNumber: A-S00000002 version: 1 subscriptionStartDate: '2021-01-01' subscriptionEndDate: '2023-01-01' termStartDate: '2021-01-01' termEndDate: '2023-01-01' accountNumber: AN_1723456739867 invoiceOwnerAccountNumber: AN_1723456739867 currency: USD orderNumber: O-00000001 type: Standard externalSubscriptionId: null changedTime: '2024-08-12 02:59:00' ratePlans: - ratePlanNumber: SRP-00000002 ratePlanCharges: - chargeNumber: C-00000002 ratePlanChargeId: 240207304399145dff314606dbe50014 effectiveStartDate: '2021-01-01' effectiveEndDate: '2023-01-01' fields: - fieldName: price oldValue: null newValue: '400' - fieldName: quantity oldValue: null newValue: '1' fields: [] fields: - fieldName: accountId oldValue: null newValue: ff8080819145e00301914606da4c613f - fieldName: autoRenew oldValue: null newValue: 'false' schema: $ref: '#/components/schemas/GetSubscriptionChangeLogsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: example: processId: processId reasons: - code: '51001122' message: '''billToContact'' may not be null' - code: '51000030' message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List change histories of subscriptions by order number tags: - Subscription Change History /v1/subscription-change-logs/{subscriptionNumber}/versions/{version}: get: description: | Retrieves the change history of a single version subscription by version. This version indicates the creation sequence of the orders associated with the subscription and starts from `1`. See the `subscription` > `fields`, `ratePlans` > `fields`, and `ratePlanCharges` > `fields` fields for the changes in the subscription, subscription rate plans, and subscription rate plan charges. **Note**: This operation is only available if you have the following features turned on: - Orders - Single Version Subscription operationId: getSubscriptionChangelogByVersion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The subscription number to be retrieved. in: path name: subscriptionNumber required: true schema: type: string - description: | This version indicates the creation sequence of the orders associated with the subscription and starts from `1`. in: path name: version required: true schema: type: string responses: '200': content: application/json: example: success: true subscription: subscriptionNumber: A-S00000001 version: 2 subscriptionStartDate: '2021-01-01' subscriptionEndDate: '2023-02-01' termStartDate: '2021-02-01' termEndDate: '2023-02-01' accountNumber: AN_1723454733315 invoiceOwnerAccountNumber: AN_1723454733315 currency: USD orderNumber: O-00000002 type: Standard externalSubscriptionId: null changedTime: '2024-08-12 02:25:36' ratePlans: - ratePlanNumber: SRP-00000001 ratePlanCharges: - chargeNumber: C-00000001 ratePlanChargeId: 28b907304229145dff3145e84432000a effectiveStartDate: '2021-01-01' effectiveEndDate: '2023-02-01' fields: - fieldName: effectiveEndDate oldValue: '2022-01-01' newValue: '2023-02-01' fields: [] fields: - fieldName: initialTerm oldValue: '12' newValue: '2' - fieldName: initialTermPeriodType oldValue: Month newValue: Year schema: $ref: '#/components/schemas/GetSubscriptionChangeLogResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: example: processId: processId reasons: - code: '51001122' message: '''billToContact'' may not be null' - code: '51000030' message: If 'billingCycleDay' is absent, 'subscription.contractEffectiveDate' is necessary success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a change history of a subscription by version tags: - Subscription Change History /v1/ppdd/reverse-rollover: post: description: | This REST API reference describes how to manually reverse fund rollover from source validity period to destination validity period. There are no path or query parameters. **Note**: This API will not work if the associated prepayment charge has rollover enabled. operationId: POST_ReverseRollover parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTReverseRolloverRequestType' required: true responses: '200': content: application/json: examples: response: value: message: Reverse rollover is done reverseRolloverFundCount: 1 success: true schema: $ref: '#/components/schemas/POSTReverseRolloverResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Reverse fund rollover tags: - Prepaid with Drawdown /v1/ppdd/rollover: post: description: | Prepaid with Drawdown Rollover enables you to transfer the accumulative carryover of your customers’ prepaid balance funds to the following validity period when using Prepaid with Drawdown. This REST API reference describes how to manually trigger fund rollover from source validity period to destination validity period. There are no path or query parameters. **Note**: This API will not work if rollover is enabled in the associated prepayment charge. If you want to trigger rollover automatically, see Create prepayment charge with rollover for more information. operationId: POST_Rollover parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTriggerRolloverRequestType' required: true responses: '200': content: application/json: examples: response: value: message: Rollover is done rolloverFundCount: 1 success: true schema: $ref: '#/components/schemas/POSTTriggerRolloverResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Trigger fund rollover tags: - Prepaid with Drawdown /v1/prepaid-balance-funds/deplete: post: description: 'Depleting a prepaid balance fund enables you to expire the remaining balance, which can be recognized by revenue. When an expiry request is received, the remaining fund balance is reduced to zero, and the related objects like PrepaidBalance, ValidityPeriodSummary, PrepaidBalanceTransaction, and DailyConsumption will be updated. ' operationId: DepleteFunds parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTDepleteFundRequestType' required: true responses: '200': content: application/json: examples: response: value: fundIds: - fundId: 4028818c8d3ade79018d3ae1048a5e10 status: success message: The fund object is depleted. - fundId: 4028818c8d3ade79018d3ae1048a5ef8 status: success message: The fund object is depleted. schema: $ref: '#/components/schemas/POSTDepleteFundResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Deplete funds tags: - Prepaid with Drawdown /v1/usage: post: description: | This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. There are no path or query parameters. The data is uploaded using the HTTP multipart/form-data POST method and applied to the user's tenant. ### How this REST API Call Works The content of the uploaded usage file must follow the format used by the UI import tool. It must be a comma-separated (CSV) file with a corresponding .csv extension. The length of the file name must not exceed 50 characters. The file size must not exceed 4MB. See [Downloading the Usage Template](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/Usage/C_Import_Usage_Data#Downloading_the_Usage_Template) to learn about how to download the usage file template. At the completion of the upload, before the file contents are actually being processed, the API returns a response containing the byte count of the received file and a URL for checking the status of the import process. Of the five possible results displayed at that URL (Pending, Processing, Completed, Canceled, and Failed) only a Completed status indicates that the import was successful. The operation is atomic; if any record fails, the file is rejected. In that case, the entire import is rolled back and all stored data is returned to its original state. To view the actual import status, enter the resulting status URL from the checkImportStatus response using a tool such as POSTMAN. This additional step provides more information about why the import has failed. To manage the information after a successful upload, use the web-based UI. ### Usage File Format The usage file uses the following headings: | Heading | Description | Required | |-----------------|--------|----------| | ACCOUNT_ID | Enter the account number, e.g., the default account number, such as A00000001, or your custom account number. Although this field is labeled as Account_Id, it is not the actual Account ID nor Account Name. | Yes | | UOM | Enter the unit of measure. This must match the UOM for the usage. | Yes | | QTY | Enter the quantity. | Yes | | STARTDATE | Enter the start date of the usage. This date determines the invoice item service period the associated usage is billed to. Date format is based on locale of the current user. Default date format: `MM/DD/YYYY`. | Yes | | ENDDATE | Enter the end date of the usage. This is not used in calculations for usage billing and is optional. Date format is based on locale of the current user. Default date format: `MM/DD/YYYY`.**Note:** The value of this column is optional, but the column header is required.
| No | | PRODUCT_RATE_PLAN_CHARGE_ID | Enter a product rate plan charge number so that you can charge your customer with a dynamic usage charge for the corresponding uploaded usage record.**Note:** The value of this column is optional, but the column header is required. To use this field, you must set the `X-Zuora-WSDL-Version` request header to `146` or higher. Otherwise, an error occurs.
| No | | SUBSCRIPTION_ID | Enter the subscription number or subscription name. If you created the subscription in the Zuora application, Zuora created a number automatically in a format similar to A-S00000001. If you do not provide a value for this field, the associated usage will be added to all subscriptions for the specified Account that use this Unit Of Measure. If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the Subscription or Charge ID in each usage record.**Note:** The value of this column is optional, but the column header is required.
| No | | CHARGE_ID | Enter the charge number (not the charge name). You can see the charge ID, e.g., C-00000001, when you add your rate plan to your subscription and view your individual charges. If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the specific Subscription or Charge ID in each usage record. This field is related to the Charge Number on the subscription rate plan.**Note:** The value of this column is optional, but the column header is required.
| No | | DESCRIPTION | Enter a description for the charge. | No | | UNIQUE_KEY | Enter a specific identifier for this usage record. **Note**: This Heading is supported by the following Advanced Consumption Billing features: Prepaid with Drawdown, and Unbilled Usage. See Upload usage record with unique key for more information. | No | operationId: POST_Usage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: multipart/form-data: schema: properties: file: description: | The usage data to import. The supported formats are excel, csv, and zip. format: binary type: string required: - file type: object required: true responses: '200': content: application/json: examples: response: value: checkImportStatus: /v1/usage/2c92c8f83dcbd8b1013dcce1159900cc/status size: 316 success: true schema: $ref: '#/components/schemas/POSTUsageResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Upload a usage file tags: - Usage x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@UsageData.csv" "https://rest.zuora.com/v1/usage" /v1/usage/accounts/{account-key}: get: description: | This REST API reference describes how to retrieve usage details for an account. Usage data is returned in reverse chronological order. operationId: GET_Usage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: Account number or account ID. in: path name: account-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true usage: - CheckType__c: null City__c: null ClockTiime__c: null Colour__c: null Meter__c: null Size__c: null Timeofday__c: null accountId: 8ad096ca865969c801865ccbfcb77adf accountName: Song accountNumber: A00000113 chargeNumber: null fileName: UsageFileFormat-178.csv id: 8ad098f08659582c01865cd2a40057a5 network__c: null quantity: 100 rate__c: null sourceName: Import startDateTime: '2023-01-15 00:00:00' state__c: null status: Pending submissionDateTime: '2023-02-16 16:42:32' subscriptionNumber: A-S00000224 timeOfUse__c: Off-Peak totalAmount__c: null uniqueKey: '123' unitOfMeasure: Ads schema: $ref: '#/components/schemas/GETUsageWrapper' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a usage record tags: - Usage /v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail: get: description: | Use this REST API operation to retrieve the usage rate detail for an invoice item to understand how the total amount is calculated. The information is the same as the Rate Detail presented on [PDF invoices](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Create_a_custom_invoice_template/DD_Display_Usage_Charge_Breakdown#How_UsageSummary.RateDetail_is_displayed_on_invoices). **Notes and limitations:** - Do not support the Overage Charge Model, Tiered with Overage Charge Model, and Multi-attribute Pricing Charge Model. - Do not support invoices in `Cancelled` or `Reversed` status. - Do not support Active rating. - In terms of rating group options, only the [Usage rating by billing period](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Rating/Usage_Rating_by_Group#Usage_rating_by_billing_period) is supported. - Do not support [On-demand usage rating](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Rating/On-demand_Usage_Rating). - Tax calculation is not involved. operationId: GET_Usage_Rate_Detail_By_Invoice_Item parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Invoice item ID. For example, `402880e57f725d85017f7267c4ad002b`. Available through Data Source export. in: path name: invoice-item-id required: true schema: type: string responses: '200': content: application/json: examples: response: value: data: amountWithoutTax: 58 chargeNumber: C-00000001 invoiceId: 402880e57f725d85017f7267c44c0028 invoiceItemId: 402880e57f725d85017f7267c4ad002b invoiceNumber: INV00000007 listPrice: | Tier / From / To / List Price / Price Format 1 / 0 / 9 / 0.00 / Per Unit 2 / 10 / 20 / 1.00 / Per Unit 3 / 21 / 30 / 2.00 / Flat Fee 4 / 31 / / 3.00 / Per Unit quantity: 45 rateDetail: |- Tier 1: 0-9, 9 Each(s) x $0.00/Each = $0.00 Tier 2: 10-20, 11 Each(s) x $1.00/Each = $11.00 Tier 3: 21-30, $2.00 Flat Fee Tier 4: >=31, 15 Each(s) x $3.00/Each = $45.00 Total = $58.00 servicePeriod: 03/01/2022-03/31/2022 uom: Each success: true schema: $ref: '#/components/schemas/GETUsageRateDetailWrapper' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve usage rate detail for an invoice item tags: - Usage /v1/object/usage: post: description: '' operationId: Object_POSTUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateUsage' required: true responses: '200': content: application/json: examples: response: value: Id: 8ad08ae29085a77b0190908bfdd67abb Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '400': content: application/json: examples: response: value: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Create a usage record' tags: - Usage /v1/object/usage/{id}: delete: description: '' operationId: Object_DELETEUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object id in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyDeleteResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Delete a usage record' tags: - Usage get: description: '' operationId: Object_GETUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object fields to return in: query name: fields required: false schema: type: string - description: Object id in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: AccountId: 2c92c0f956bc8fb40156d502fc3718b1 AccountNumber: A00000030 ChargeId: 2c92c0f956bc8fcb0156d5039e275aa9 ChargeNumber: C-00000229 CreatedById: 2c92c0f958fffd7d015914aeefc71a5d CreatedDate: '2019-07-18T15:36:43.000+08:00' Description: test Id: 2c92c0f86bf50ca0016c040309316ca4 Quantity: 9 RbeStatus: Pending SourceType: API StartDateTime: '2017-12-01T23:41:36.000+08:00' SubmissionDateTime: '2019-07-18T15:36:43.000+08:00' SubscriptionId: 2c92c0f956bc8fcb0156d5039e0a5aa0 SubscriptionNumber: A-S00000100 UOM: Each UpdatedById: 2c92c0f958fffd7d015914aeefc71a5d UpdatedDate: '2019-07-18T15:36:43.000+08:00' schema: $ref: '#/components/schemas/ProxyGetUsage' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '404': content: application/json: examples: response: value: done: true records: {} size: 0 schema: $ref: '#/components/schemas/ProxyNoDataResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Retrieve a usage record' tags: - Usage put: description: '' operationId: Object_PUTUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object id in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyModifyUsage' required: true responses: '200': content: application/json: examples: response: value: Id: 8ad08ae29085a77b0190908bfdd67abb Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Update a usage record' tags: - Usage /v1/adjustments: get: description: | Describes how to retrieve detailed information about delivery adjustments of a subscription. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. operationId: GET_Subscription_Adjustments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | A subscription number. in: query name: subscription-number required: true schema: type: string responses: '200': content: application/json: examples: response: value: adjustments: - adjustmentId: 4028818886a2149b0186a237d0ff003b adjustmentNumber: ADJ-00000001 amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: CM00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Billed subscriptionNumber: A-S00000001 - adjustmentId: 4028818886a2149b0186a2404f67003c adjustmentNumber: ADJ-00000002 amount: -5 billingDate: '2023-02-27' chargeNumber: C-00000001 creditMemoNumber: CM00000002 debitMemoNumber: DM00000002 deferredRevenueAccountingCode: string deliveryDate: '2023-02-27' deliveryDay: monday reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Cancelled subscriptionNumber: A-S00000001 success: true schema: $ref: '#/components/schemas/GETAdjustmentsBySubscriptionNumberResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all delivery adjustments of a subscription tags: - Delivery Adjustments post: description: | Describes how to create one or more delivery adjustments for a subscription. **Notes**: - The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. - This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “success = true” as well as eligible delivery adjustments and ineligible delivery adjustments are returned in the response; only when no delivery adjustment is eligible, “success=false” is returned. operationId: Create_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateBillingAdjustmentRequestType' required: true responses: '200': content: application/json: examples: response: value: adjustments: - adjustmentId: 4028818886a2149b0186a237d0ff003b adjustmentNumber: ADJ-00000001 amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: CM00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday eligible: true reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Billed subscriptionNumber: A-S00000001 ineligibleAdjustments: - adjustmentId: null adjustmentNumber: null amount: null billingDate: null chargeNumber: C-00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-27' deliveryDay: monday eligible: false errorMessage: Subscription does not have a delivery scheduled for this day reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: null subscriptionNumber: A-S00000001 success: true totalAmount: -5 totalNumberOfDeliveries: 1 schema: $ref: '#/components/schemas/GETAdjustmentsResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/preview: post: description: | Describes how to preview delivery adjustments of a subscription. **Notes**: - The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. - This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “success = true” as well as eligible delivery adjustments and ineligible delivery adjustments are returned in the response; only when no delivery adjustment is eligible, “success=false” is returned. operationId: Preview_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPreviewBillingAdjustmentRequestType' required: true responses: '200': content: application/json: examples: response: value: adjustments: - adjustmentId: 'null' adjustmentNumber: 'null' amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: null deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday eligible: true reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: null subscriptionNumber: A-S00000001 ineligibleAdjustments: - adjustmentId: null adjustmentNumber: null amount: null billingDate: null chargeNumber: C-00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-27' deliveryDay: monday eligible: false errorMessage: Subscription does not have a delivery scheduled for this day reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: null subscriptionNumber: A-S00000001 success: true totalAmount: -5 totalNumberOfDeliveries: 1 schema: $ref: '#/components/schemas/GETAdjustmentsResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Preview a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/{adjustment-key}: get: description: | Describes how to retrieve detailed information about a delivery adjustment. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. operationId: GET_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The delivery adjustment ID or number to retrieve. in: path name: adjustment-key required: true schema: type: string responses: '200': content: application/json: examples: response: value: adjustmentId: 4028818886a2149b0186a2404f67003c adjustmentNumber: ADJ-00000001 amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: CM00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Billed subscriptionNumber: A-S00000001 schema: $ref: '#/components/schemas/GETAdjustmentByIdResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/{adjustmentId}/cancel: put: description: | Describes how to cancel an unbilled delivery adjustment. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. operationId: PUT_CancelAdjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID of the delivery adjustment to cancel. in: path name: adjustmentId required: true schema: format: UUID type: string responses: '200': content: application/json: examples: response: value: debitMemoNumber: DM00000001 success: true schema: $ref: '#/components/schemas/GETCancelAdjustmentResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Cancel a delivery adjustment tags: - Delivery Adjustments /v1/billing-documents: get: description: | Retrieves the information about all billing documents associated with a specified account. The billing documents contain invoices, credit memos, and debit memos. To retrieve information about credit memos and debit memos, you must have the Invoice Settlement feature enabled. You can use query parameters to restrict the data returned in the response. Examples: - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&sort=+documentDate - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&status=Posted - /billing-documents?accountNumber=A00000001&sort=+documentDate - /billing-documents?accountNumber=A00000001&status=Posted operationId: GET_BillingDocuments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The ID of the customer account that the billing documents are associated with. **Note**: When retrieving information about all billing documents associated with an account, you must specify either `accountId` or `accountNumber` in the query parameters. in: query name: accountId required: false schema: format: uuid type: string - description: | The number of the customer account that the billing documents are associated with. **Note**: When retrieving information about all billing documents associated with an account, you must specify either `accountId` or `accountNumber` in the query parameters. in: query name: accountNumber required: false schema: format: uuid type: string - description: | The date of the billing document. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. in: query name: documentDate required: false schema: format: date type: string - description: | The status of the billing document. in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error type: string - description: | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. If you do not specify any sortable field, the response data is sorted by the `documentDate` field in descending order. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - documentDate - documentType Examples: - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1 &sort=+documentDate,-documentType - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1 &status=Posted&sort=+documentDate&page=2&pageSize=15 in: query name: sort required: false schema: type: string responses: '200': content: application/json: examples: response: value: documents: - accountId: 4028905f5e4feb38bbb50af9aa002d1 accountNumber: A00000001 amount: 100 balance: 90 documentDate: '2017-10-01' documentNumber: INV-0000001 documentType: Invoice id: 4028905f5e4jjj015e50af9aa002d1 status: Posted currency: USD - accountId: 4028905f5e4feb38b111b50af9aa002d1 accountNumber: A00000001 amount: 100 balance: 90 documentDate: '2017-09-01' documentNumber: CM-0000001 documentType: CreditMemo id: 4028905f5e4jbbb015e50af9aa002d1 status: Posted currency: USD - accountId: 4028905f5e4feb3833b50af9aa002d1 accountNumber: A00000001 amount: 100 balance: 90 documentDate: '2017-07-01' documentNumber: DM-0000001 documentType: DebitMemo id: 4028905f5e4jccc015e50af9aa002d1 status: Posted currency: USD success: true schema: $ref: '#/components/schemas/BillingDocumentQueryResponseElementType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List billing documents for an account tags: - Billing Documents x-code-samples: - label: Curl lang: curl source: | curl -X GET -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type: application/json" "https://rest.sandbox.eu.zuora.com/v1/billing-documents?accountId=402892c74c9193cd014c91d35b0a0132" /v1/accounts/billing-documents/files/deletion-jobs: post: description: | Creates an asynchronous job to permanently delete all billing document PDF files for specific accounts. After the deletion job is completed, all billing document PDF files are permanently deleted. To retrieve the status of a deletion job, call [Retrieve a job of hard deleting billing document files](https://developer.zuora.com/api-references/api/operation/GET_BillingDocumentFilesDeletionJob). **Note**: This operation can be used only if you have the Billing user permission "Hard Delete Billing Document Files" enabled. operationId: POST_BillingDocumentFilesDeletionJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBillingDocumentFilesDeletionJobRequest' required: true responses: '200': content: application/json: examples: response: value: id: 2c92c8f83dc4f752013dc72c24ee016c status: Pending success: true schema: $ref: '#/components/schemas/POSTBillingDocumentFilesDeletionJobResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a job to hard delete billing document files tags: - Billing Documents /v1/accounts/billing-documents/files/deletion-jobs/{jobId}: get: description: | Retrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts. **Note**: This operation can be used only if you have the Billing user permission "Hard Delete Billing Document Files" enabled. operationId: GET_BillingDocumentFilesDeletionJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c. in: path name: jobId required: true schema: type: string responses: '200': content: application/json: examples: response: value: id: 2c92c8f83dc4f752013dc72c24ee016c status: Pending success: true schema: $ref: '#/components/schemas/GETBillingDocumentFilesDeletionJobResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a job of hard deleting billing document files tags: - Billing Documents /v1/accounts/{key}/billing-documents/generate: post: description: | Generates draft or posted billing documents for a specified account. You can also generate billing documents for specified subscriptions of a specified account. The billing documents contain invoices and credit memos. To generate credit memos, you must have the Invoice Settlement feature enabled. **Note**: You cannot generate billing documents for cancelled or suspended subscriptions. operationId: POST_GenerateBillingDocuments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419 or AC0000001. in: path name: key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PostGenerateBillingDocumentType' required: true responses: '200': content: application/json: examples: response: value: invoices: - id: 8ad084db909fae930190a121c84957ff creditMemos: [] success: true schema: $ref: '#/components/schemas/GenerateBillingDocumentResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Generate billing documents by account ID tags: - Billing Documents /v1/invoices: post: description: | Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers. To use this operation, you must have the "Create Standalone Invoice" and "Modify Invoice" user permissions. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. As of Zuora Release 2022.03.R5, newly created standard Billing users have the “Create Standalone Invoice” permission enabled by default. operationId: POST_StandaloneInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostInvoiceType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad084db909fae930190a121c84957ff invoiceNumber: INV00000155 accountId: 8ad09be48db5aba7018db604776d4854 amount: 100 amountWithoutTax: 100 discount: 0 invoiceDate: '2024-07-30' dueDate: '2024-08-29' autoPay: false comments: null status: Draft taxAmount: 0 taxExemptAmount: 0 transferredToAccounting: null sourceType: Standalone billToContactId: null soldToContactId: null templateId: null paymentTerm: null sequenceSetId: null adjustmentAmount: 0 balance: 100 billToContactSnapshotId: null creditMemoAmount: 0 includesOneTime: true includesRecurring: true includesUsage: true lastEmailSentDate: null paymentAmount: 0 postedBy: null postedDate: null refundAmount: 0 soldToContactSnapshotId: null source: API sourceId: null targetDate: null taxMessage: null taxStatus: Complete createdById: b243314d594646d3b2651aeedd4be47e createdDate: '2024-07-11 02:31:04' updatedById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-07-11 02:31:04' billRunId: null currency: USD invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/PostInvoiceResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a standalone invoice tags: - Invoices put: description: | Updates multiple invoices in batches with one call. The following tutorials demonstrate how to use this operation: - Add and delete invoice items of draft standalone invoices - Edit due dates of draft standalone invoices - Edit invoice item prices and custom fields of draft standalone invoices ### Limitations - You can update a maximum of 50 invoices by one call. operationId: PUT_BatchUpdateInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutBatchInvoiceType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update invoices tags: - Invoices /v1/invoices/batch: post: description: | Creates multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers. To use this operation, you must have the "Create Standalone Invoice" and "Modify Invoice" user permissions. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. As of Zuora Release 2022.03.R5, newly created standard Billing users have the “Create Standalone Invoice” permission enabled by default. ### Limitations This operation has the following limitations: * You can create a maximum of 50 invoices in one request. * You can create a maximum of 1,000 invoice items in one request. operationId: POST_StandaloneInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostBatchInvoicesType' required: true responses: '200': content: application/json: examples: response: value: invoices: - IntegrationId__NS: string IntegrationStatus__NS: string SyncDate__NS: string accountId: 4028818484f483d20184f4f7efc40001 adjustmentAmount: 0 amount: 700 amountWithoutTax: 700 autoPay: true balance: 700 billRunId: 4028818484f483d20184f50064950035 billToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 comments: '' complexity__c: Middle createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2022-12-08 19:49:16' currency: USD description__c: description discount: 0 dueDate: '2022-11-30' id: 4028818484f483d20184f5006b97003f includesOneTime: true includesRecurring: true includesUsage: true invoiceDate: '2022-10-31' invoiceGroupNumber: N-0001 invoiceNumber: INV00000001 lastEmailSentDate: '2022-12-08 19:51:16' paymentAmount: 0 postedBy: 402881e522cf4f9b0122cf5d82860002 postedDate: '2022-12-09' refundAmount: 0 sequenceSetId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860005 source: BillRun sourceId: BR-00000001 sourceType: Subscription status: Posted success: true targetDate: '2022-10-31' transferredToAccounting: string updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2022-12-08 19:51:23' - objectIndex: 1 processId: CA037C0B8C5B0682 reasons: - code: 58490020 message: No account is found with accountId ff8080817cda56fa017cda87aaa2071f. success: false success: true schema: $ref: '#/components/schemas/PostBatchInvoiceResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create standalone invoices tags: - Invoices /v1/invoices/bulk-post: post: description: | Posts multiple invoices. You can post a maximum of 50 invoices in one single request. Additionally, you can also update invoice dates while posting the invoices. operationId: POST_PostInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTInvoicesBatchPostType' required: true responses: '200': content: application/json: examples: response: value: invoices: - id: 402890555a7e9791015a7f15fe440123 success: true - id: 402890555a7e9791015a7f15fe44013a success: true - id: ff808081804f25b001804f2d8971079f processId: F3D4DAF98E6CE569 reasons: - code: 59210020 message: Only invoices with Draft status can be posted. success: false success: true schema: $ref: '#/components/schemas/InvoicesBatchPostResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Post invoices tags: - Invoices /v1/invoices/pdf-status: get: description: 'Retrieves the PDF generation statuses of a batch of invoices. ' operationId: GetInvoicePdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: The IDs or numbers of the invoices separated by commas. For example - `?invoiceKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,INV-0000001`. A maximum of 50 keys can be entered in this field. in: query name: invoiceKeys required: true schema: type: string - description: |2 The minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. in: header name: zuora-version required: false schema: type: string responses: '200': content: application/json: example: invoiceFiles: - invoiceId: 402824aa8cc894d5018cc8a120576881 invoiceNumber: INV00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - invoiceId: 2c98908a904dfc2601904e6e14090241 invoiceNumber: INV00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - invoiceId: 402824aa8cc894d5018cc8a120576881 invoiceNumber: INV00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true schema: $ref: '#/components/schemas/GetInvoicePdfStatusBatchResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '400': content: application/json: example: processId: processId reasons: - code: '50000020' message: Credit memo key is required success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Forbidden headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve the PDF file generation status of invoices tags: - Invoices x-accepts: application/json /v1/invoices/{invoiceKey}: delete: description: | Deletes a specific invoice. Whether to delete an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 100 items, the invoice is deleted synchronously. Otherwise, the invoice is deleted asynchronously. If you want to change the threshold, submit a request at Zuora Global Support. operationId: DELETE_DeleteInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: id: 40288ae9600808280160081dc9c13f15 jobId: 40288ae9600808280160081db1533506 jobStatus: Completed success: true schema: $ref: '#/components/schemas/DeleteInvoiceResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete an invoice tags: - Invoices get: description: | Retrieves a specific invoice. operationId: Get_GetInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: IntegrationId__NS: string IntegrationStatus__NS: string SyncDate__NS: string accountId: 4028818484f483d20184f4f7efc40001 adjustmentAmount: 0 amount: 700 amountWithoutTax: 700 autoPay: true balance: 700 billRunId: 4028818484f483d20184f50064950035 billToContactSnapshotId: 402881e522cf4f9b0122cf5d82860010 comments: '' complexity__c: Middle createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2022-12-08 19:49:16' currency: USD description__c: description discount: 0 dueDate: '2022-11-30' id: 4028818484f483d20184f5006b97003f includesOneTime: true includesRecurring: true includesUsage: true invoiceDate: '2022-10-31' invoiceGroupNumber: N-0001 invoiceNumber: INV00000001 lastEmailSentDate: '2022-12-08 19:51:16' paymentAmount: 0 postedBy: 402881e522cf4f9b0122cf5d82860002 postedDate: '2022-12-09' refundAmount: 0 sequenceSetId: 402881e522cf4f9b0122cf5d82860009 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860011 source: BillRun sourceId: BR-00000001 sourceType: Subscription status: Posted success: true targetDate: '2022-10-31' transferredToAccounting: string updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2022-12-08 19:51:23' schema: $ref: '#/components/schemas/PostInvoiceResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve an invoice tags: - Invoices put: description: | Updates a specific invoice. Updates multiple invoices in batches with one call. The following tutorials demonstrate how to use this operation: - Add and delete invoice items of draft standalone invoices - Edit due dates of draft standalone invoices - Edit invoice item prices and custom fields of draft standalone invoices operationId: PUT_UpdateInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PutInvoiceType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad084db909fae930190a121c84957ff number: INV00000155 accountId: 8ad09be48db5aba7018db604776d4854 invoiceDate: '2024-07-30' currency: USD targetDate: null dueDate: '2024-08-29' postedOn: null postedById: null status: Draft amount: 105 taxAmount: 0 totalTaxExemptAmount: 0 balance: 105 discount: 0 comment: null autoPay: false transferredToAccounting: 'No' creditBalanceAdjustmentAmount: 0 createdDate: '2024-07-11 02:31:04' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-07-11 02:43:45' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null success: true schema: $ref: '#/components/schemas/PutInvoiceResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update an invoice tags: - Invoices /v1/invoices/{invoiceKey}/application-parts: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. If you are in Zuora version 341, this operation will return only processed payments applied to the invoices. If you are in the Zuora version less than 341, this operation behavior remains the same and returns all payments associated with the invoice regardless of the payment status. Retrieves information about the payments or credit memos that are applied to a specified invoice. operationId: GET_InvoiceApplicationParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: applicationParts: - appliedAmount: 22 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:42:16' creditMemoId: 4028905f60a165a50160b4f632ff023d paymentId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:42:16' - appliedAmount: 11 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:41:38' creditMemoId: null paymentId: 4028905f60a165a50160b4f5d5cb0229 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:41:38' success: true schema: $ref: '#/components/schemas/GetInvoiceApplicationPartCollectionType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all application parts of an invoice tags: - Invoices /v1/invoices/{invoiceKey}/einvoice/generate: put: description: | Generates an e-invoice file for an invoice. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_GenerationEInvoiceGenerationForInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Generate an e-invoice file for an invoice tags: - Invoices /v1/invoices/{invoiceKey}/emails: post: description: | Sends a posted invoice to the specified email addresses manually. ### Notes - You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information. - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Invoice Posted Default Email Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. - The invoices are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met: * The `useEmailTemplateSetting` field is set to `false`. * The email addresses are not specified in the `emailAddresses` field. operationId: POST_EmailInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PostInvoiceEmailRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Email an invoice tags: - Invoices /v1/invoices/{invoiceKey}/files: get: description: | Retrieves the information about all PDF files of a specified invoice. Invoice PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response. You can use the [Query](https://developer.zuora.com/api-references/api/operation/Action_POSTquery) action to get the latest PDF file, for example: `"select Body from Invoice where Id = '2c93808457d787030157e0324aea5158'"`. See [Query an Invoice Body](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/Invoice/Query_an_Invoice_Body_Field) for more information. operationId: GET_InvoiceFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: invoiceFiles: - id: 2c98901f62d7d83d0162d7facec2262f pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d versionNumber: 1524041954479 - id: 2c98901f62d7d83d0162d7f4a9792629 pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7f4a95c2627 versionNumber: 1524041551946 - id: 2c98901f62d7d83d0162d7f491ea2626 pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7f490f22624 versionNumber: 1524041544112 success: true schema: $ref: '#/components/schemas/GETInvoiceFilesResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all files of an invoice tags: - Invoices post: description: | Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status. To use this operation, you must enable the Modify Invoice permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one invoice. operationId: POST_UploadFileForInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string requestBody: content: multipart/form-data: schema: properties: file: description: | The PDF file to upload for the invoice. format: binary type: string type: object responses: '200': content: application/json: examples: response: value: fileId: 40289f466463d683016463ef8b7301a2 success: true schema: $ref: '#/components/schemas/POSTUploadFileResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Upload a file for an invoice tags: - Invoices x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@InvoiceFile.pdf" "https://rest.zuora.com/v1/invoices/2c92c8955bd63cc1015bd7c151af02ab/files" /v1/invoices/{invoiceKey}/items: get: description: | Retrieves the information about all items of a specified invoice. operationId: GET_InvoiceItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: invoiceItems: - appliedToItemId: null balance: 21.1 chargeAmount: 21.1 chargeDate: '2015-11-20 19:53:00' chargeDescription: '' chargeId: 2c92c0f9511f56b2015126814af832d2 chargeName: Annual Fee chargeType: Recurring description: '' excludeItemBillingFromRevenueAccounting: true id: 2c92c095511f5b4401512682dd017989 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge productName: TeamCollab Enterprise quantity: 1 serviceEndDate: '2015-11-30' serviceStartDate: '2015-11-20' soldToContactId: 2c92c0f9511f56b2015126814ad532cd soldToContactSnapshotId: 2c92c0f9511f56b2015126814ad532cd sourceItemType: SubscriptionComponent subscriptionId: 2c92c0f9511f56b2015126814ad532cc subscriptionName: A-S00000004 taxAmount: 0 taxationItems: data: - balance: 2.11 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce6eeb0ffe jurisdiction: County locationCode: 000-1 name: taxName paymentAmount: 0 taxAmount: 2.11 taxCode: TAXCODE-1 taxCodeDescription: null taxDate: '2015-11-20' taxRate: 0.1 taxRateDescription: '' taxRateType: Percentage unitOfMeasure: '' unitPrice: 21.1 - appliedToItemId: 2c92c095511f5b4401512682dd017989 chargeAmount: -2.1 chargeDate: '2015-11-20 19:53:00' chargeDescription: '' chargeId: 1b3dede652fa47db833a83be55d850a5 chargeName: Discount chargeType: OneTime description: '' excludeItemBillingFromRevenueAccounting: true id: 3e28d61d442f433797e268e2b7c11eeb invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Discount productName: TeamCollab Enterprise quantity: 0 serviceEndDate: '2015-11-30' serviceStartDate: '2015-11-20' soldToContactId: 2c92c0f9511f56b2015126814ad532cd soldToContactSnapshotId: 2c92c0f9511f56b2015126814ad532cd sourceItemType: SubscriptionComponent subscriptionId: c2d9a5768db440cbbf2709a55c614bed subscriptionName: A-S00000004 taxAmount: 0 taxationItems: data: - balance: 0.21 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce6eeb0ffe jurisdiction: County locationCode: 000-1 name: taxName paymentAmount: 0 taxAmount: 0.21 taxCode: TAXCODE-1 taxCodeDescription: null taxDate: '2015-11-20' taxRate: 0.1 taxRateDescription: '' taxRateType: Percentage unitOfMeasure: '' unitPrice: 10 success: true schema: $ref: '#/components/schemas/GETInvoiceItemsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all items of an invoice tags: - Invoices /v1/invoices/{invoiceKey}/items/{itemId}/taxation-items: get: description: | Retrieves information about the taxation items of a specific invoice item. operationId: GET_TaxationItemsOfInvoiceItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string - description: | The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef. in: path name: itemId required: true schema: type: string responses: '200': content: application/json: examples: response: value: data: - balance: 10 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce84e3102c jurisdiction: test locationCode: code - 001 name: test paymentAmount: 0 taxAmount: 10 taxCode: taxcode taxCodeDescription: description taxDate: '2019-02-18' taxRate: 2 taxRateDescription: test taxRateType: FlatFee - balance: 10 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce85d6102e jurisdiction: test locationCode: code - 001 name: test paymentAmount: 0 taxAmount: 10 taxCode: taxcode taxCodeDescription: description taxDate: '2019-02-18' taxRate: 2 taxRateDescription: test taxRateType: FlatFee success: true schema: $ref: '#/components/schemas/GETInvoiceTaxationItemsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all taxation items of an invoice item tags: - Invoices /v1/invoices/{invoiceKey}/reverse: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Reverses a posted invoice. **Restrictions** You are not allowed to reverse an invoice if any of the following restrictions is met: * Payments and credit memos are applied to the invoice. * The invoice is split. * The invoice is not in Posted status. * The total amount of the invoice is less than 0 (a negative invoice). * Using Tax Connector for Extension Platform to calculate taxes. * An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items. See [Invoice Reversal](https://knowledgecenter.zuora.com/CB_Billing/IA_Invoices/Reverse_Posted_Invoices) for more information. operationId: PUT_ReverseInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PutReverseInvoiceType' required: true responses: '200': content: application/json: examples: response: value: creditMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PutReverseInvoiceResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Reverse an invoice tags: - Invoices /v1/invoices/{invoiceKey}/taxationitems: post: description: | Creates taxation items for an invoice. operationId: POST_INV_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001. in: path name: invoiceKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemList' required: true responses: '200': content: application/json: examples: response: value: success: true taxationItems: - createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:08:43' exemptAmount: 0 financeInformation: accountsReceivableAccountingCode: Check accountsReceivableAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a7e9791015a87a072880062 invoiceItemId: 402890555a7e9791015a879f064d0055 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX taxAmount: 0.1 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-09-30' taxMode: TaxExclusive taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' schema: $ref: '#/components/schemas/GETTaxationItemListType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create taxation items for an invoice tags: - Invoices /v1/invoices/{invoiceKey}/write-off: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Writes off a posted invoice. By writing off an invoice, a credit memo is created and applied to the invoice. The generated credit memo items and credit memo taxation items are applied to invoice items and invoice taxation items based on the configured default application rule. If an invoice is written off, the balance of each invoice item and invoice taxation item must be zero. If you set the **Create credit memos mirroring invoice items billing rule** to **Yes**, you can write off an invoice even if all its items have zero balance. **Restrictions**: You cannot write off an invoice if any of the following restrictions is met: * The balance of an invoice has been changed before Invoice Settlement is enabled. For example, before Invoice Settlement is enabled, any credit balance adjustments, invoice item adjustments, or invoice adjustments have been applied to an invoice. * An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items. See [Invoice Write-off](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Invoice_Write-Off) for more information. operationId: PUT_WriteOffInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTWriteOffInvoiceRequest' required: true responses: '200': content: application/json: examples: response: value: creditMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PUTWriteOffInvoiceResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Write off an invoice tags: - Invoices /v1/creditmemos: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all credit memos. For a use case of this operation, see [Get credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo). ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. Examples: - /v1/creditmemos?status=Posted - /v1/creditmemos?referredInvoiceId=null&status=Draft - /v1/creditmemos?status=Posted&type=External&sort=+number operationId: GET_CreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | This parameter filters the response based on the `accountId` field. in: query name: accountId required: false schema: type: string - description: | This parameter filters the response based on the `accountNumber` field. in: query name: accountNumber required: false schema: type: string - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `appliedAmount` field. in: query name: appliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `autoApplyUponPosting` field. in: query name: autoApplyUponPosting required: false schema: type: boolean - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `creditMemoDate` field. in: query name: creditMemoDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `currency` field. in: query name: currency required: false schema: type: string - description: | This parameter filters the response based on the `excludeFromAutoApplyRules` field. in: query name: excludeFromAutoApplyRules required: false schema: type: boolean - description: | This parameter filters the response based on the `number` field. in: query name: number required: false schema: type: string - description: | This parameter filters the response based on the `referredInvoiceId` field. in: query name: referredInvoiceId required: false schema: type: string - description: | This parameter filters the response based on the `refundAmount` field. in: query name: refundAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `status` field. in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string - description: | This parameter filters the response based on the `targetDate` field. in: query name: targetDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `taxAmount` field. in: query name: taxAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `totalTaxExemptAmount` field. in: query name: totalTaxExemptAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `transferredToAccounting` field. in: query name: transferredToAccounting required: false schema: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string - description: | This parameter filters the response based on the `unappliedAmount` field. in: query name: unappliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - description: | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by credit memo number. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - accountId - amount - appliedAmount - createdById - createdDate - creditMemoDate - number - referredInvoiceId - refundAmount - status - targetDate - taxAmount - totalTaxExemptAmount - transferredToAccounting - unappliedAmount - updatedDate Examples: - /v1/creditmemos?sort=+number - /v1/creditmemos?status=Processed&sort=-number,+amount in: query name: sort required: false schema: type: string responses: '200': content: application/json: examples: response: value: creditmemos: - accountId: 2c92c8f95bd63b98015bd7ab09ef0926 accountNumber: A00000001 amount: 23 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 2c92c8f95b79c9ad015b80614273052c createdDate: '2017-05-05 01:39:30' creditMemoDate: '2017-05-05' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null excludeFromAutoApplyRules: false id: 2c92c8f95bd63b94015bd7c39289112e invoiceGroupNumber: N-0001 latestPDFFileId: 2c92c8955bd63b6c015bd7c395e90023 number: CM00000002 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: null refundAmount: 0 reversed: false sequenceSetId: null source: BillRun sourceId: BR-00000024 sourceType: Standalone status: Draft targetDate: null taxAmount: 0 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 23 updatedById: 2c92c8f95b79c9ad015b80614273052c updatedDate: '2017-05-05 01:39:30' - accountId: 2c92c8f95bd63b98015bd7ab09ef0926 accountNumber: A00000001 amount: 10 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 2c92c8f95b79c9ad015b80614273052c createdDate: '2017-05-05 01:15:23' creditMemoDate: '2017-05-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null excludeFromAutoApplyRules: false id: 2c92c8f95bd63b9d015bd7ad7fe206f9 invoiceGroupNumber: N-0001 latestPDFFileId: 2c92c8955bd63b6c015bd7ad8921001d number: CM00000001 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: 2c92c8955bd63cc1015bd7c151af02ab refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromInvoice sourceId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 10 updatedById: 2c92c8f95b79c9ad015b80614273052c updatedDate: '2017-05-05 01:15:24' success: true schema: $ref: '#/components/schemas/GETCreditMemoCollectionType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List credit memos tags: - Credit Memos post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates an ad-hoc credit memo from a product rate plan charge. Zuora supports the creation of credit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models. When credit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency. You can create a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: POST_CreditMemoFromPrpc parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditMemoFromChargeRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8ad08f0091698a7a01916e70df165b3b number: CM00000010 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 currency: USD creditMemoDate: '2024-08-19' targetDate: null postedById: null postedOn: null status: Draft amount: 10 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 10 refundAmount: 0 appliedAmount: 0 comment: null source: AdhocFromPrpc sourceId: null referredInvoiceId: null reasonCode: Correcting invoice error createdDate: '2024-08-19 23:19:36' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-08-19 23:19:36' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a credit memo from a charge tags: - Credit Memos /v1/creditmemos/bulk: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates multiple credit memos from invoices or product rate plan charges. You can create a maximum of 50 credit memos in one single request. - If you set the `sourceType` request field to `Invoice`, you can create multiple credit memos from invoices. - If you set the `sourceType` request field to `Standalone`, you can create multiple credit memos from product rate plan charges. The credit memos that are created are each in separate database transactions. If the creation of one credit memo fails, other credit memos can still be created successfully. You can create credit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. Zero-amount memo items are supported in the following scenarios: - If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero. - If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice. operationId: POST_CreateCreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkCreditMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: ff8080817fe9d7b9017fe9e5234d04cb accountNumber: A00000001 amount: 100 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: test createdById: ff8080817fe9d7b9017fe9e41732030e createdDate: '2022-04-02 18:49:47' creditMemoDate: '2022-04-02' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null excludeFromAutoApplyRules: false id: ff8080817fe9d7b9017fe9e5382f04f5 invoiceGroupNumber: N-0001 latestPDFFileId: null number: CM00000001 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0 refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromInvoice sourceId: null sourceType: Invoice status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 100 updatedById: ff8080817fe9d7b9017fe9e41732030e updatedDate: '2022-04-02 18:49:47' - objectIndex: 1 processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id test. success: false success: true schema: $ref: '#/components/schemas/BulkCreditMemosResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create credit memos tags: - Credit Memos put: description: | **Notes:** - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. - You can update credit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. Updates the basic and finance information about multiple credit memos. You can update a maximum of 50 credit memos in one single request. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The Edit credit and debit memos tutorial demonstrates how to use this operation to add and delete memo items. The credit memos that are updated are each in separate database transactions. If the update of one credit memo fails, other credit memos can still be updated successfully. operationId: PUT_UpdateCreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBulkCreditMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: ff8080817fe9d7b9017fe9e5234d04cb accountNumber: A00000001 amount: 100 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: test createdById: ff8080817fe9d7b9017fe9e41732030e createdDate: '2022-04-02 18:49:47' creditMemoDate: '2022-04-02' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null excludeFromAutoApplyRules: false id: ff8080817fe9d7b9017fe9e5382f04f5 invoiceGroupNumber: N-0001 latestPDFFileId: null number: CM00000001 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0 refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromInvoice sourceId: null sourceType: Invoice status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 100 updatedById: ff8080817fe9d7b9017fe9e41732030e updatedDate: '2022-04-02 18:49:47' - id: ff8080817fe9d7b9017fe9e41732030f objectIndex: 1 processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id. success: false success: true schema: $ref: '#/components/schemas/BulkCreditMemosResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update credit memos tags: - Credit Memos /v1/creditmemos/pdf-status: get: description: | Retrieves the PDF generation statuses of a batch of credit memos. operationId: Get_CreditMemoPdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: 'The IDs or numbers of the credit memos separated by commas. For example - `?creditMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,CM0000001`. A maximum of 50 keys can be entered in this field. ' in: query name: creditMemoKeys required: true schema: type: string - description: |2 The minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. in: header name: zuora-version required: false schema: type: string responses: '200': content: application/json: example: creditMemoFiles: - creditMemoId: 402824aa8cc894d5018cc8a120576881 creditMemoNumber: CM00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - creditMemoId: 2c98908a904dfc2601904e6e14090241 creditMemoNumber: CM00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - creditMemoId: 402824aa8cc894d5018cc8a120576881 creditMemoNumber: CM00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true schema: $ref: '#/components/schemas/GetCreditMemoPdfStatusBatchResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '400': content: application/json: example: processId: processId reasons: - code: '50000020' message: Credit memo key is required success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Forbidden headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve the PDF file generation status of credit memos tags: - Credit Memos x-accepts: application/json /v1/creditmemos/{creditMemoId}/items/{cmitemid}/taxation-items: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about the taxation items of a specific credit memo item. operationId: GET_TaxationItemsOfCreditMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems). in: path name: cmitemid required: true schema: type: string - description: | The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoId required: true schema: type: string responses: '200': content: application/json: examples: response: value: data: - appliedAmount: 0 exemptAmount: 10 financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null salesTaxPayableAccountingCode: null salesTaxPayableAccountingCodeType: null id: 2c98901a68ff2680016903216a271a67 jurisdiction: Jurisdiction locationCode: '8' name: taxName_0 refundAmount: 0 sourceTaxItemId: null taxAmount: 10 taxCode: taxCode taxCodeDescription: taxCodeDescription taxDate: '2016-10-10' taxRate: 0.1 taxRateDescription: taxRateDescription taxRateType: Percentage unappliedAmount: 10 success: true schema: $ref: '#/components/schemas/GETTaxationItemsOfCreditMemoItemType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all taxation items of a credit memo item tags: - Credit Memos /v1/creditmemos/{creditMemoId}/write-off: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Write off a fully unapplied credit memo. When writing off a credit memo, a debit memo is automatically created, and then the credit memo to be written off is fully applied to the debit memo. Note that this operation only supports writing off credit memos that are fully unapplied. Credit memos that are not fully unapplied cannot be written off by this operation. operationId: PUT_WriteOffCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTCreditMemoWriteOff' required: true responses: '200': content: application/json: examples: response: value: debitMemo: id: 4028905f5a87c0ff015a87e49e6b0062 success: true schema: $ref: '#/components/schemas/PUTCreditMemoWriteOffResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Write off a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}: delete: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Deletes a credit memo. Only credit memos with the Cancelled status can be deleted. You can delete a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: DELETE_CreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a credit memo tags: - Credit Memos get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific credit memo. For a use case of this operation, see [Get credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo). operationId: GET_CreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 3.1 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditMemoDate: '2017-03-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null excludeFromAutoApplyRules: false id: 402890555a7e9791015a879f064a0054 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a7e9791015a879f07fb005e number: CM00000012 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: 402890555a7e9791015a7f1756aa0035 refundAmount: 0 reversed: false sequenceSetId: null source: API sourceId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0.1 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 3.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' schema: $ref: '#/components/schemas/GETCreditMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a credit memo tags: - Credit Memos put: description: | **Notes:** - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. - You can update a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. Updates the basic and finance information about a credit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The [Edit credit and debit memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API) tutorial demonstrates how to use this operation to add and delete memo items. operationId: PUT_UpdateCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad081dd91698b2801916e637b19583f number: CM00000008 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 currency: USD creditMemoDate: '2024-08-19' targetDate: null postedById: null postedOn: null status: Draft amount: 14.99 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 14.99 refundAmount: 0 appliedAmount: 0 comment: Details about this Credit Memo source: AdhocFromPrpc sourceId: null referredInvoiceId: null reasonCode: Ad hoc credit createdDate: '2024-08-19 23:04:59' createdById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-19 23:05:55' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: true autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/apply: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Applies a posted credit memo to one or more invoices and debit memos. You can apply a credit memo to an invoice or a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. When you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 15,000. If the limit is hit, you can follow the following instructions: - If you want to apply one credit memo to multiple invoices or debit memos, decrease the number of invoices or debit memos in the request. - If you want to apply one credit memo to a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000. - If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000. If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 15,000: (number of invoice items + number of debit memo items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule. operationId: PUT_ApplyCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad081dd91698b2801916e5a84b65653 number: CM00000007 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 currency: USD creditMemoDate: '2024-08-19' targetDate: null postedById: 8ad09fc28193c189018194da28be74ba postedOn: '2024-08-19 22:55:11' status: Posted amount: 14.99 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 3.99 refundAmount: 0 appliedAmount: 11 comment: '' source: AdhocFromPrpc sourceId: null referredInvoiceId: null reasonCode: Ad hoc credit createdDate: '2024-08-19 22:55:11' createdById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-19 22:59:54' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: true autoApplyUponPosting: false reversed: false taxStatus: null sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Apply a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/cancel: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Cancels a credit memo. Only credit memos with the Draft status can be cancelled. You can cancel a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: PUT_CancelCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 2020 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: '2017-09-03 19:59:07' comment: the comment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 15:31:10' creditMemoDate: '2017-10-17' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null excludeFromAutoApplyRules: false id: 402890555a87d7f5015a88c7a6830022 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a87d7f5015a88c7a7a2002a number: CM00000015 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: null refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromPrpc sourceId: null sourceType: Standalone status: Canceled success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 2020 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 15:36:57' schema: $ref: '#/components/schemas/GETCreditMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Cancel a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/einvoice/generate: put: description: | Generates an e-invoice file for a credit memo. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_GenerateEInvoiceFileForCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM-0000001. in: path name: creditMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Generate an e-invoice file for a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/emails: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Sends a posted credit memo to the specified email addresses manually. ### Notes - You must activate the **Email Credit Memo | Manually email Credit Memo** notification before emailing credit memos. To include the credit memo PDF in the email, select the **Include Credit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information. - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Credit Memo Default Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. - The credit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met: * The `useEmailTemplateSetting` field is set to `false`. * The email addresses are not specified in the `emailAddresses` field. operationId: POST_EmailCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PostCreditMemoEmailRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Email a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/files: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Uploads an externally generated PDF file for a credit memo that is in Draft or Posted status. To use this operation, you must enable the Modify Modify Credit Memo permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one credit memo. operationId: POST_UploadFileForCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054 or CM00000001. in: path name: creditMemoKey required: true schema: type: string requestBody: content: multipart/form-data: schema: properties: file: description: | The PDF file to upload for the credit memo. format: binary type: string type: object responses: '200': content: application/json: examples: response: value: fileId: 40289f466463d683016463ef8b7301a4 success: true schema: $ref: '#/components/schemas/POSTUploadFileResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Upload a file for a credit memo tags: - Credit Memos x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@CreditMemoFile.pdf" "https://rest.zuora.com/v1/creditmemos/402890555a7e9791015a879f064a0054/files" get: description: | Retrieves the information about all PDF files of a specified credit memo. Credit Memo PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response. operationId: GET_CreditMemoFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: creditMemoFiles: - id: 8a90a24f8e128020018e12cf610f03f9 pdfFileUrl: /v1/files/8a90a24f8e128020018e12cf610903f8 versionNumber: 1709712563443 - id: 8a90b5148c6d127b018c6d1e3c6e022e pdfFileUrl: /v1/files/8a90b5148c6d127b018c6d1e3c68022d versionNumber: 1702637739555 success: true schema: $ref: '#/components/schemas/GETCreditMemoFilesResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all files of a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/items: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all items of a credit memo. A credit memo item is a single line item in a credit memo. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. Examples: - /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100 - /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate operationId: GET_CreditMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `appliedAmount` field. in: query name: appliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `id` field. in: query name: id required: false schema: type: string - description: | This parameter filters the response based on the `refundAmount` field. in: query name: refundAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `serviceEndDate` field. in: query name: serviceEndDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `serviceStartDate` field. in: query name: serviceStartDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `sku` field. in: query name: sku required: false schema: type: string - description: | This parameter filters the response based on the `skuName` field. in: query name: skuName required: false schema: type: string - description: | This parameter filters the response based on the `sourceItemId` field. in: query name: sourceItemId required: false schema: type: string - description: | This parameter filters the response based on the `subscriptionId` field. in: query name: subscriptionId required: false schema: type: string - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - description: | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by updated date. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - amount - appliedAmount - createdById - createdDate - id - refundAmount - serviceEndDate - serviceStartDate - sku - skuName - sourceItemId - subscriptionId - updatedById - updatedDate Examples: - /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate - /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate in: query name: sort required: false schema: type: string responses: '200': content: application/json: examples: response: value: items: - amount: 1 amountWithoutTax: 0 appliedAmount: 0 appliedToItemId: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditFromItemId: 402880e97a56f30b017a574012e50085 creditFromItemSource: CreditMemoItem excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: null deferredRevenueAccountingCodeType: null onAccountAccountingCode: null onAccountAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null id: 402890555a7e9791015a879f064d0055 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge quantity: 1 refundAmount: 0 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000001 skuName: New Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7e9791015a7f1756bc0037 sourceItemType: InvoiceDetail subscriptionId: 402890d25bec1155015bec35cc7c0bc7 taxMode: TaxExclusive taxationItems: data: - appliedAmount: 0 exemptAmount: 0 financeInformation: onAccountAccountingCode: Check onAccountAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a7e9791015a87a072880062 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX refundAmount: 0 sourceTaxItemId: null taxAmount: 0.1 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-09-30' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage unappliedAmount: 0.1 unappliedAmount: 1 unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' - amount: 2 amountWithoutTax: 2 appliedAmount: 0 appliedToItemId: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditFromItemId: 402880e97a56f30b017a574012f00086 creditFromItemSource: CreditMemoItem excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: null deferredRevenueAccountingCodeType: null onAccountAccountingCode: null onAccountAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null id: 402890555a7e9791015a879f06610056 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge quantity: 1 refundAmount: 0 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000001 skuName: New Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7e9791015a7f1756bd0038 sourceItemType: InvoiceDetail subscriptionId: 402890d25bec1155015bec35cc7c0bc7 taxMode: TaxExclusive taxationItems: data: [] unappliedAmount: 2 unitOfMeasure: Each unitPrice: 2 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:07:10' success: true schema: $ref: '#/components/schemas/GETCreditMemoItemsListType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List credit memo items tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/items/{cmitemid}: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific item of a credit memo. A credit memo item is a single line item in a credit memo. operationId: GET_CreditMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems). in: path name: cmitemid required: true schema: type: string - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string responses: '200': content: application/json: examples: response: value: amount: 1 amountWithoutTax: 1 appliedAmount: 0 appliedToItemId: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditFromItemId: 402880e97a56f30b017a574012f00086 creditFromItemSource: CreditMemoItem excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: null deferredRevenueAccountingCodeType: null onAccountAccountingCode: null onAccountAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null id: 402890555a7e9791015a879f064d0055 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge quantity: 1 refundAmount: 0 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000001 skuName: New Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7e9791015a7f1756bc0037 sourceItemType: InvoiceDetail subscriptionId: 402890d25bec1155015bec35cc7c0bc7 success: true taxMode: TaxExclusive taxationItems: data: [] unappliedAmount: 1 unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' schema: $ref: '#/components/schemas/GETCreditMemoItemType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a credit memo item tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/parts: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all parts of a credit memo. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a credit memo. Note that a fully refunded credit memo does not contain any credit memo part. operationId: GET_CreditMemoParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: parts: - amount: 3.66 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-02 13:21:55' debitMemoId: null id: 4028905f5a890526015a8d77adea0029 invoiceId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 13:21:55' success: true schema: $ref: '#/components/schemas/GETCreditMemoPartsCollectionType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all parts of a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/parts/{partid}: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific credit memo part. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. A fully refunded credit memo does not contain any credit memo part. operationId: GET_CreditMemoPart parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit memo](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoParts). in: path name: partid required: true schema: type: string - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: amount: 1 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-02 14:00:21' debitMemoId: null id: 4028905f5a890526015a8d9adeb30059 invoiceId: 4028905f5a87c0ff015a87d3f8f10043 success: true updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 14:00:21' schema: $ref: '#/components/schemas/GETCreditMemoPartType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a credit memo part tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/pdfs: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates a PDF file for a specified credit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed credit memo page through the Zuora UI. This REST API operation can be used only if you have the billing document file generation feature and the Billing user permission "Regenerate PDF" enabled. operationId: POST_CreditMemoPDF parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/POSTMemoPdfResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Generate a credit memo PDF file tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/post: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Posts a credit memo to activate it. You can post credit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). operationId: PUT_PostCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 3.1 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditMemoDate: '2017-03-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null excludeFromAutoApplyRules: false id: 402890555a7e9791015a879f064a0054 invoiceGroupNumber: N-0001 latestPDFFileId: null number: CM00000012 postedById: 402881e522cf4f9b0122cf5d82860002 postedOn: '2017-03-01 14:28:06' reasonCode: Correcting invoice error referredInvoiceId: 402890555a7e9791015a7f1756aa0035 refundAmount: 0 reversed: false sequenceSetId: null source: API sourceId: null sourceType: Standalone status: Posted success: true targetDate: null taxAmount: 0.1 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 3.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 14:28:06' schema: $ref: '#/components/schemas/GETCreditMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Post a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/refunds: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Refunds a full or partial posted credit memo to your customers. Only the amount of unapplied part could be refunded. You can refund a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. When you refund a credit memo, the total number of credit memo items to be refunded must be less than or equal to 15,000. For a use case of this operation, see [Refund processing](https://developer.zuora.com/rest-api/general-concepts/authentication//#Refund-processing). operationId: POST_RefundCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001. in: path name: creditMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PostNonRefRefundType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad0937890e7fca00190e8c290d46fad number: R-00000001 status: Processed type: Electronic methodType: CreditCard accountId: 8ad09be48db5aba7018db604776d4854 amount: 10 refundDate: '2024-07-25' comment: null paymentMethodId: 8ad084db90a5e73b0190c02783f552fa paymentMethodSnapshotId: 8ad0937890e7fca00190e8c290b86fab paymentId: null paymentNumber: null creditMemoId: 8ad0835290c4bb2f0190d9955e414e62 reasonCode: null gatewayId: 2c92c0f972bc6aa90172bc77ccaf379a paymentGatewayNumber: null gatewayResponse: This transaction has been approved by Test gateway. gatewayResponseCode: approve gatewayState: Submitted markedForSubmissionOn: null referenceId: 7002728.053836375 secondRefundReferenceId: null softDescriptor: null softDescriptorPhone: null submittedOn: '2024-07-25 00:19:43' settledOn: null cancelledOn: null createdDate: '2024-07-25 00:19:43' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-07-25 00:19:43' updatedById: b243314d594646d3b2651aeedd4be47e refundTransactionTime: '2024-07-25 00:19:43' financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null unappliedPaymentAccountingCode: Accounts Receivable unappliedPaymentAccountingCodeType: AccountsReceivable onAccountAccountingCode: null onAccountAccountingCodeType: null transferredToAccounting: 'No' gatewayReconciliationStatus: null gatewayReconciliationReason: null payoutId: null success: true schema: $ref: '#/components/schemas/GETRefundCreditMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Refund a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/reverse: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Reverses a posted credit memo. See [Reverse credit memos](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos/C_Management_of_Credit_and_Debit_Memos/Reverse_credit_memos) for more information. You can reverse a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. **Restrictions** You cannot reverse credit memos if any of the following conditions is met: * A credit memo's applied amount is not 0. * A credit memo is not in Posted status. * A credit memo contains more than 2,000 items in total, including credit memo items, discount items, and taxation items. operationId: PUT_ReverseCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001. in: path name: creditMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PutReverseCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: debitMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PutReverseCreditMemoResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Reverse a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/taxationitems: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates taxation items for a credit memo. operationId: POST_CM_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemListForCMType' required: true responses: '200': content: application/json: examples: response: value: success: true taxationItems: - createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:08:43' exemptAmount: 0 financeInformation: onAccountAccountingCode: Check onAccountAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a7e9791015a87a072880062 jurisdiction: CALIFORNIA locationCode: '06' memoItemId: 402890555a7e9791015a879f064d0055 name: STATE TAX sourceTaxItemId: 402890555a7d4022015a7db254e200c1 taxAmount: 0.1 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-09-30' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' schema: $ref: '#/components/schemas/GETTaxationItemListType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create taxation items for a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/unapply: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Unapplies an applied credit memo from one or more invoices and debit memos. The full applied amount from invoices and debit memos is transferred into the unapplied amount of the credit memo. You can unapply a credit memo from an invoice or a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. When you unapply a credit memo, the total number of credit memo items and the items that credit memo items to be unapplied from must be less than or equal to 15,000. If the limit is hit, you can follow the following instructions: - If you want to unapply one credit memo without specifying invoices or debit memos and the limit is hit, you have to specify the invoice items or debit memo items in the request to decrease the number of items. - If you want to unapply one credit memo from multiple specified invoices or debit memos, decrease the number of invoices or debit memos in the request. - If you want to unapply one credit memo from a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000. - If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000. - When unapplying a credit memo, the total number of the credit memo's item parts must be less than or equal to 1,000. Otherwise, the operation would fail and an error message would pop up. When you see this error, you can try using the Unapply a credit memo API as an alternative. Similarly, make sure that all the requirements listed in the API reference are met. If the Proration application rule is used, when unapplying credit memos, the following quantity must be less than or equal to 15,000: (number of invoice items + number of debit memo items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule. operationId: PUT_UnapplyCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UnapplyCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: accountId: 4028905f5a87c0ff015a87d25ae90025 accountNumber: A00000001 amount: 10.76 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-02 13:17:51' creditMemoDate: '2017-03-02' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null excludeFromAutoApplyRules: true id: 4028905f5a890526015a8d73f73d0015 invoiceGroupNumber: N-0001 latestPDFFileId: 4028905f5a890526015a8d77af600036 number: CM00000001 postedById: 402881e522cf4f9b0122cf5d82860002 postedOn: '2017-03-02 13:21:55' reasonCode: Correcting invoice error referredInvoiceId: 4028905f5a87c0ff015a87d3f8f10043 refundAmount: 7.1 reversed: false sequenceSetId: null source: AdhocFromPrpc sourceId: null sourceType: Standalone status: Posted success: true targetDate: null taxAmount: 0.76 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 3.66 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 13:25:29' schema: $ref: '#/components/schemas/GETCreditMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Unapply a credit memo tags: - Credit Memos /v1/creditmemos/{creditMemoKey}/unpost: put: description: |- **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Unposts a credit memo that is in Posted status. If a credit memo has been applied or refunded, you are not allowed to unpost it. After a credit memo is unposted, its status becomes Draft. You can unpost credit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). You can prevent an unpost operation by configuring the 'Do not allow unposting invoices and memos if their revenue is already recognized in a closed accounting period' accounting rule. The default value of this rule is set to 'disabled.' For more information, see [Configure Accounting Rules](https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance/D_Finance_Settings/D_Configure_Accounting_Rules#Do_not_allow_unposting_invoices_and_memos_if_their_revenue_is_already_recognized_in_a_closed_accounting_period). operationId: PUT_UnpostCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 3.1 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditMemoDate: '2017-03-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null excludeFromAutoApplyRules: false id: 402890555a7e9791015a879f064a0054 invoiceGroupNumber: N-0001 latestPDFFileId: null number: CM00000012 postedById: 402881e522cf4f9b0122cf5d82860002 postedOn: '2017-03-01 14:28:06' reasonCode: Correcting invoice error referredInvoiceId: 402890555a7e9791015a7f1756aa0035 refundAmount: 0 reversed: false sequenceSetId: null source: API sourceId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0.1 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 3.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 14:28:06' schema: $ref: '#/components/schemas/GETCreditMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Unpost a credit memo tags: - Credit Memos /v1/invoices/{invoiceKey}/creditmemos: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates an ad-hoc credit memo from an invoice. You can create a credit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. For a use case of this operation, see [Create credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Create-credit-memo). Zero-amount memo items are supported in the following scenarios: - If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero. - If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice. operationId: POST_CreditMemoFromInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - description: | The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001. in: path name: invoiceKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditMemoFromInvoiceRequest' required: true responses: '200': content: application/json: examples: response: value: accountId: 402890555a7d4022015a7dabf5f60088 accountNumber: A00000001 amount: 0.01 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: the comment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 15:19:42' creditMemoDate: '2017-11-30' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null excludeFromAutoApplyRules: false excludeItemBillingFromRevenueAccounting: true id: 402890555a87d7f5015a88bd27f80014 invoiceGroupNumber: N-0001 latestPDFFileId: null number: CM00000013 postedById: null postedOn: null reasonCode: Write-off referredInvoiceId: 402890555a7d4022015a7dadb3b300a4 refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromInvoice sourceId: null sourceType: Invoice status: Draft success: true targetDate: null taxAmount: 0.01 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 0.01 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 15:19:42' schema: $ref: '#/components/schemas/GETCreditMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a credit memo from an invoice tags: - Credit Memos /v1/debitmemos: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all debit memos associated with all customer accounts. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. Examples: - /v1/debitmemos?status=Posted - /v1/debitmemos?referredInvoiceId=null&status=Draft - /v1/debitmemos?status=Posted&type=External&sort=+number operationId: GET_DebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | This parameter filters the response based on the `accountId` field. in: query name: accountId required: false schema: type: string - description: | This parameter filters the response based on the `accountNumber` field. in: query name: accountNumber required: false schema: type: string - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `balance` field. in: query name: balance required: false schema: format: double type: number - description: | This parameter filters the response based on the `beAppliedAmount` field. in: query name: beAppliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `currency` field. in: query name: currency required: false schema: type: string - description: | This parameter filters the response based on the `debitMemoDate` field. in: query name: debitMemoDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `dueDate` field. in: query name: dueDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `number` field. in: query name: number required: false schema: type: string - description: | This parameter filters the response based on the `referredInvoiceId` field. in: query name: referredInvoiceId required: false schema: type: string - description: | This parameter filters the response based on the `status` field. in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string - description: | This parameter filters the response based on the `targetDate` field. in: query name: targetDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `taxAmount` field. in: query name: taxAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `totalTaxExemptAmount` field. in: query name: totalTaxExemptAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - description: | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by debit memo number. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - number - accountId - debitMemoDate - targetDate - dueDate - amount - taxAmount - totalTaxExemptAmount - balance - beAppliedAmount - referredInvoiceId - createdDate - createdById - updatedDate - updatedById Examples: - /v1/debitmemos?sort=+number - /v1/debitmemos?status=Processed&sort=-number,+amount in: query name: sort required: false schema: type: string responses: '200': content: application/json: examples: response: value: debitmemos: - accountId: 402890555a7e9791015a7f15fe44001c accountNumber: AN_1679649466484 amount: 50 autoPay: true balance: 50 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: the comment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:24:14' currency: USD debitMemoDate: '2017-10-17' dueDate: '2017-11-16' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 402890555a87d7f5015a892f2ba10057 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a87d7f5015a892f2c5c0060 number: DM00000006 paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:24:14' - accountId: 402890555a7d4022015a7dabf5f60088 accountNumber: AN_1679649466488 amount: 0.01 autoPay: true balance: 0.01 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: the comment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:13:15' currency: USD debitMemoDate: '2017-11-30' dueDate: '2017-12-30' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 402890555a87d7f5015a89251edc0045 invoiceGroupNumber: N-0001 latestPDFFileId: null number: DM00000003 paymentTerm: null postedById: null postedOn: null reasonCode: Charge Dispute referredInvoiceId: 402890555a7d4022015a7dadb3b300a4 sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0.01 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:13:15' - accountId: 402890555a7d4022015a7dabf5f60088 accountNumber: AN_1679649466488 amount: 9 autoPay: true balance: 9 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:01:00' currency: USD debitMemoDate: '2017-03-01' dueDate: '2017-03-31' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 402890555a87d7f5015a8919e4fe002e invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a87d7f5015a8919e95d003a number: DM00000002 paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: null referredInvoiceId: 402890555a7d4022015a7dadb3b300a4 sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 8 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:01:00' - accountId: 402890555a7e9791015a7f15fe44001c accountNumber: AN_1679649466684 amount: 8.02 autoPay: true balance: 8.02 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:26:16' currency: USD debitMemoDate: '2017-03-01' dueDate: '2017-03-31' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 402890555a7e9791015a87b082940067 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a7e9791015a87b083f00072 number: DM00000001 paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: null referredInvoiceId: 402890555a7e9791015a7f1756aa0035 sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0.02 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:45:03' success: true schema: $ref: '#/components/schemas/GETDebitMemoCollectionType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List debit memos tags: - Debit Memos post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates an ad-hoc debit memo from a product rate plan charge. Zuora supports the creation of debit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models. When debit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency. You can create a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: POST_DebitMemoFromPrpc parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoFromChargeRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8ad093789169a0c001916e6be7cf7113 number: DM00000002 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 debitMemoDate: '2024-08-19' currency: USD targetDate: null dueDate: '2024-09-18' postedOn: null postedById: null status: Draft amount: 10 taxAmount: 0 totalTaxExemptAmount: 0 balance: 10 beAppliedAmount: 0 autoPay: true comment: null referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2024-08-19 23:14:11' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-08-19 23:14:11' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null referredCreditMemoId: null latestPDFFileId: null taxStatus: Complete sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETDebitMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a debit memo from a charge tags: - Debit Memos put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Updates the due date for multiple debit memos in one single request. This API operation will be deprecated. You can use the [Update debit memos](https://developer.zuora.com/api-references/api/operation/PUT_BulkUpdateDebitMemos) instead, which provides more flexible functionality. operationId: PUT_UpdateDebitMemosDueDates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBatchDebitMemosRequest' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update due dates for debit memos tags: - Debit Memos /v1/debitmemos/bulk: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates multiple debit memos from invoices or product rate plan charges. You can create a maximum of 50 debit memos in one single request. - If you set the `sourceType` request field to `Invoice`, you can create multiple debit memos from invoices. - If you set the `sourceType` request field to `Standalone`, you can create multiple debit memos from product rate plan charges. The debit memos that are created are each in separate database transactions. If the creation of one debit memo fails, other debit memos can still be created successfully. You can create debit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: POST_CreateDebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkDebitMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: 4028ab1f87121698018712fef63e33cb accountNumber: AN_Test11679650911374 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: 3e2bcd869cea43eeb00d7a20cc1cb72b createdDate: '2023-03-24 15:12:01' currency: USD debitMemoDate: '2023-03-24' dueDate: '2023-03-24' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 4028ab1f87121698018712ff1b0633e2 invoiceGroupNumber: N-0001 latestPDFFileId: null number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: null referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 3e2bcd869cea43eeb00d7a20cc1cb72b updatedDate: '2023-03-24 15:12:01' - objectIndex: 1 processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id test. success: false success: true schema: $ref: '#/components/schemas/BulkDebitMemosResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create debit memos tags: - Debit Memos put: description: | **Notes:** - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. - You can update debit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. Updates the basic and finance information about multiple debit memos. You can update a maximum of 50 credit memos in one single request. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The [Edit credit and debit memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API) tutorial demonstrates how to use this operation to add and delete memo items. The credit memos that are updated are each in separate database transactions. If the update of one debit memo fails, other debit memos can still be updated successfully. operationId: PUT_UpdateDebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBulkDebitMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: 4028ab1f87121698018726851cc765ee accountNumber: AN_Test11679978470016 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: new comment123 createdById: aff81dbb5dd846868685592640363b5b createdDate: '2023-03-28 10:11:45' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 4028ab1f8712169801872685a5f46605 invoiceGroupNumber: N-0001 latestPDFFileId: null number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: null referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: aff81dbb5dd846868685592640363b5b updatedDate: '2023-03-28 10:12:37' - id: 2c98907562482a8301624b9c0a1a0056 objectIndex: 1 processId: string reasons: - code: string message: string success: false success: true schema: $ref: '#/components/schemas/BulkDebitMemosResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update debit memos tags: - Debit Memos /v1/debitmemos/pdf-status: get: description: | Retrieves the PDF generation statuses of a batch of debit memos. operationId: Get_DebitMemoPdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: 'The IDs or numbers of the debit memos separated by commas. For example - `?debitMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,DM0000001`. A maximum of 50 keys can be entered in this field. ' in: query name: debitMemoKeys required: true schema: type: string - description: |2 The minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. in: header name: zuora-version required: false schema: type: string responses: '200': content: application/json: example: debitMemoFiles: - debitMemoId: 402824aa8cc894d5018cc8a120576881 debitMemoNumber: DM00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:32:19' updatedOn: '2024-01-01 11:32:19' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - debitMemoId: 2c98908a904dfc2601904e6e14090241 debitMemoNumber: DM00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - debitMemoId: 402824aa8cc894d5018cc8a120576881 debitMemoNumber: DM00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true schema: $ref: '#/components/schemas/GetDebitMemoPdfStatusBatchResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '400': content: application/json: example: processId: processId reasons: - code: '50000020' message: Credit memo key is required success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Forbidden headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve the PDF file generation status of debit memos tags: - Debit Memos x-accepts: application/json /v1/debitmemos/{debitMemoId}/application-parts: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about the payments or credit memos that are applied to a specified debit memo. If you use the Zuora version 341.0 or a [later available version](https://developer.zuora.com/v1-api-reference/api-versions/), this operation will return only processed payments applied to the debit memos. For Zuora versions earlier than 341.0, it returns all payments associated with the debit memo regardless of the payment status. operationId: GET_DebitMemoApplicationParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. in: path name: debitMemoId required: true schema: type: string responses: '200': content: application/json: examples: response: value: applicationParts: - appliedAmount: 22 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:42:16' creditMemoId: 4028905f60a165a50160b4f632ff023d paymentId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:42:16' - appliedAmount: 11 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:41:38' creditMemoId: null paymentId: 4028905f60a165a50160b4f5d5cb0229 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:41:38' success: true schema: $ref: '#/components/schemas/GetDebitMemoApplicationPartCollectionType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all application parts of a debit memo tags: - Debit Memos /v1/debitmemos/{debitMemoId}/items/{dmitemid}/taxation-items: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about the taxation items of a specific debit memo item. operationId: GET_TaxationItemsOfDebitMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems). in: path name: dmitemid required: true schema: type: string - description: | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. in: path name: debitMemoId required: true schema: type: string responses: '200': content: application/json: examples: response: value: data: - balance: 10 creditAmount: 0 exemptAmount: 10 financeInformation: salesTaxPayableAccountingCode: null salesTaxPayableAccountingCodeType: null id: 402883836904567d01690530df760231 jurisdiction: Jurisdiction locationCode: '8' name: taxName_0 paymentAmount: 0 sourceTaxItemId: null taxAmount: 10 taxCode: taxCode taxCodeDescription: taxCodeDescription taxDate: '2016-10-10' taxRate: 0.1 taxRateDescription: taxRateDescription taxRateType: Percentage success: true schema: $ref: '#/components/schemas/GETTaxationItemsOfDebitMemoItemType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all taxation items of a debit memo item tags: - Debit Memos /v1/debitmemos/{debitMemoKey}: delete: description: |- **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Deletes a debit memo. Only debit memos with the Cancelled status can be deleted. You can delete a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. The Edit credit and debit memos tutorial demonstrates how to use this operation to add and delete memo items. operationId: DELETE_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. in: path name: debitMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a debit memo tags: - Debit Memos get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific debit memo. operationId: GET_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722ff25be58a1 accountNumber: AN_Test11679919358984 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: 0124a1a5d0f84d4288d875fc3b34b1e1 createdDate: '2023-03-27 17:46:01' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 4028ab1f87121698018722ff2bff58b8 invoiceGroupNumber: N-0001 latestPDFFileId: null number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: null referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 0124a1a5d0f84d4288d875fc3b34b1e1 updatedDate: '2023-03-27 17:46:01' schema: $ref: '#/components/schemas/GETDebitMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a debit memo tags: - Debit Memos put: description: | **Notes:** - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. - You can update a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. Updates the basic and finance information about a debit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The [Edit credit and debit memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API) tutorial demonstrates how to use this operation to add and delete memo items. operationId: PUT_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTDebitMemoType' required: true responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722f82d133fe4 accountNumber: AN_Test11679918902100 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: Details about this Debit Memo createdById: 97e12d40f0ab4418a95a93118b272fb6 createdDate: '2023-03-27 17:38:24' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 4028ab1f87121698018722f8335b3ffb invoiceGroupNumber: N-0001 latestPDFFileId: null number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: null referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 97e12d40f0ab4418a95a93118b272fb6 updatedDate: '2023-03-27 17:38:27' schema: $ref: '#/components/schemas/GETDebitMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a debit memo tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/cancel: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Cancels a debit memo. Only debit memos with the Draft status can be cancelled. You can cancel a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: PUT_CancelDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. in: path name: debitMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722fd2e705066 accountNumber: AN_Test11679919230033 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: bc0211e8ca1440eb97a0aff808f87293 cancelledOn: '2023-03-27 17:43:59' comment: This is a comment createdById: bc0211e8ca1440eb97a0aff808f87293 createdDate: '2023-03-27 17:43:52' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 4028ab1f87121698018722fd34c6507d invoiceGroupNumber: N-0001 latestPDFFileId: 4028ab1f87121698018722fd39fe5087 number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: null referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Canceled success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: bc0211e8ca1440eb97a0aff808f87293 updatedDate: '2023-03-27 17:43:59' schema: $ref: '#/components/schemas/GETDebitMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Cancel a debit memo tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/collect: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. This API operation provides an easy way to let the client-side to collect an existing posted debit memo. It supports the following steps: 1. Apply unapplied credit memos to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied credit memos. 2. Apply unapplied payments to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied payments. 3. Process payment to the posted debit memo if there is an open-balance on it. **Restrictions** Since this API will do lots of works, and some of them are resource consuming, we need to restrict the usage of this API by the following conditions: 1. If the target debit memo gets more than 10 debit memo items, the request will be rejected. 2. If `CreditMemo` is specified in `applicationOrder`, when there are more than 25 credit memos will be used to apply to the debit memo, the request will be rejected. 3. If `CreditMemo` is specified in `applicationOrder`, when there are more than 100 credit memo items will be used to apply to the debit memo, the request will be rejected. 4. If `UnappliedPayment` is specified in `applicationOrder`, when there are more than 25 payments will be used to apply to the debit memo, the request will be rejected. operationId: POST_DebitMemoCollect parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. in: path name: debitMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoCollectRequest' required: true responses: '200': content: application/json: examples: response: value: appliedCreditMemos: - appliedAmount: 12.8 id: 2c98902f6f1de6d1016f1def4c003bd8 number: CM00000452 unappliedAmount: 0 - appliedAmount: 9.99 id: 2c98902f6f1de6d1016f1deef1b93bbe number: CM00009201 unappliedAmount: 0 appliedPayments: - appliedAmount: 3.33 id: 2c98902f6f1de6d1016f1defbf3e3bf5 number: P-00001602 unappliedAmount: 0 - appliedAmount: 1.2 id: 2c98902f6f1de6d1016f1def887f3bec number: P-00001761 unappliedAmount: 0 debitMemo: id: 2c98902f6f1de6d1016f1dfc86aa3c34 number: DM00003326 processedPayment: amount: 12.68 gatewayId: 2c98902f6f1de6d1016f1ded559f3b9d gatewayResponse: This transaction has been approved by Test gateway. gatewayResponseCode: approve id: 2c98902f6f1de6d1016f1dfc8ad23c68 number: P-00001803 paymentMethodId: 2c98902f6f1de6d1016f1dedba313ba2 status: Processed success: true schema: $ref: '#/components/schemas/DebitMemoCollectResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Collect a posted debit memo tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/einvoice/generate: put: description: | Generates an e-invoice file for a debit memo. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_GenerateEInvoiceFileForDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the debit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or DM-0000001. in: path name: debitMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Generate an e-invoice file for a debit memo tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/emails: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Sends a posted debit memo to the specified email addresses manually. ### Notes - You must activate the **Email Debit Memo | Manually email Debit Memo** notification before emailing debit memos. To include the debit memo PDF in the email, select the **Include Debit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information. - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Debit Memo Default Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. - The debit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met: * The `useEmailTemplateSetting` field is set to `false`. * The email addresses are not specified in the `emailAddresses` field. operationId: POST_EmailDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PostDebitMemoEmailType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Email a debit memo tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/files: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Uploads an externally generated PDF file for a debit memo that is in Draft or Posted status. To use this operation, you must enable the Modify Debit Memo permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one debit memo. operationId: POST_UploadFileForDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e or DM00000001. in: path name: debitMemoKey required: true schema: type: string requestBody: content: multipart/form-data: schema: properties: file: description: | The PDF file to upload for the debit memo. format: binary type: string type: object responses: '200': content: application/json: examples: response: value: fileId: 40289f466463d683016463ef8b7301a3 success: true schema: $ref: '#/components/schemas/POSTUploadFileResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Upload a file for a debit memo tags: - Debit Memos x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@DebitMemoFile.pdf" "https://rest.zuora.com/v1/debitmemos/402890555a87d7f5015a8919e4fe002e/files" get: description: | Retrieves the information about all PDF files of a specified debit memo. Debit Memo PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response. operationId: GET_DebitMemoFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: debitMemoFiles: - id: 8a90a24f8e128020018e12ebcd010470 pdfFileUrl: /v1/files/8a90a24f8e128020018e12ebccfa046f versionNumber: 1709714426109 - id: 8a90b5148c6d127b018c6d1e46160230 pdfFileUrl: /v1/files/8a90b5148c6d127b018c6d1e4610022f versionNumber: 1702637741618 success: true schema: $ref: '#/components/schemas/GETDebitMemoFilesResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List all files of a debit memo tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/items: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all items of a debit memo. A debit memo item is a single line item in a debit memo. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. Examples: - /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100 - /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate operationId: GET_DebitMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `beAppliedAmount` field. in: query name: beAppliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `id` field. in: query name: id required: false schema: type: string - description: | This parameter filters the response based on the `serviceEndDate` field. in: query name: serviceEndDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `serviceStartDate` field. in: query name: serviceStartDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `sku` field. in: query name: sku required: false schema: type: string - description: | This parameter filters the response based on the `skuName` field. in: query name: skuName required: false schema: type: string - description: | This parameter filters the response based on the `sourceItemId` field. in: query name: sourceItemId required: false schema: type: string - description: | This parameter filters the response based on the `subscriptionId` field. in: query name: subscriptionId required: false schema: type: string - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - description: | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: *operator* *field_name* You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by updated date. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - id - amount - beAppliedAmount - sku - skuName - serviceStartDate - serviceEndDate - sourceItemId - createdDate - createdById - updatedDate - updatedById - subscriptionId Examples: - /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate - /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate in: query name: sort required: false schema: type: string responses: '200': content: application/json: examples: response: value: items: - amount: 1 amountWithoutTax: 1 appliedToItemId: 402890555a7d4022015a2dadb3b700a6 balance: 1 beAppliedAmount: 0 comment: This is comment! createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:13:15' excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: Subscription Revenue deferredRevenueAccountingCodeType: SalesRevenue recognizedRevenueAccountingCode: Subscription Revenue recognizedRevenueAccountingCodeType: SalesRevenue id: 402890555a87d7f5015a89251ede0046 processingType: Charge quantity: 1 serviceEndDate: '2017-11-30' serviceStartDate: '2017-11-01' sku: SKU-00000002 skuName: SKU-30 soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7d4022015a7dadb3b700a6 sourceItemType: InvoiceDetail subscriptionId: null taxMode: TaxExclusive taxationItems: data: - balance: 0.01 creditAmount: 0 exemptAmount: 0 financeInformation: salesTaxPayableAccountingCode: null salesTaxPayableAccountingCodeType: null id: 402890555a87d7f5015a89251ef10047 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX paymentAmount: 0 sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1 taxAmount: 0.01 taxCode: ZtaxCode taxCodeDescription: '' taxDate: '2017-11-30' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:13:15' success: true schema: $ref: '#/components/schemas/GETDebitMemoItemCollectionType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List debit memo items tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/items/{dmitemid}: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about a specific item of a debit memo. A debit memo item is a single line item in a debit memo. operationId: GET_DebitMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems). in: path name: dmitemid required: true schema: type: string - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string responses: '200': content: application/json: examples: response: value: amount: 1 amountWithoutTax: 1 appliedToItemId: 402890555a7d4022015a2dadb3b700a6 balance: 1 beAppliedAmount: 0 comment: aa createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:01:00' excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: Subscription Revenue deferredRevenueAccountingCodeType: SalesRevenue recognizedRevenueAccountingCode: Subscription Revenue recognizedRevenueAccountingCodeType: SalesRevenue id: 402890555a87d7f5015a8919e500002f processingType: Charge quantity: 1 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000002 skuName: ZTax Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7d4022015a7dadb3b700a6 sourceItemType: InvoiceDetail subscriptionId: null success: true taxMode: TaxExclusive taxationItems: data: - balance: 5 creditAmount: 0 exemptAmount: 0 financeInformation: salesTaxPayableAccountingCode: null salesTaxPayableAccountingCodeType: null id: 402890555a87d7f5015a8919e8450031 jurisdiction: USA locationCode: '' name: my tax paymentAmount: 0 sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1 taxAmount: 5 taxCode: ZtaxCode taxCodeDescription: '' taxDate: '2017-02-27' taxRate: 5 taxRateDescription: desc3 taxRateType: FlatFee unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:01:00' schema: $ref: '#/components/schemas/GETDebitMemoItemType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a debit memo item tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/pdfs: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates a PDF file for a specified debit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed debit memo page through the Zuora UI. This REST API operation can be used only if you have the billing document file generation feature and the Billing user permission "Regenerate PDF" enabled. operationId: POST_DebitMemoPDF parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/POSTMemoPdfResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Generate a debit memo PDF file tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/post: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Posts a debit memo to activate it. You can post debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). operationId: PUT_PostDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722fa86dc4823 accountNumber: AN_Test11679919056161 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: e758a64e80f54439913241f9aa537127 createdDate: '2023-03-27 17:40:58' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 4028ab1f87121698018722fa8d73483a invoiceGroupNumber: N-0001 latestPDFFileId: null number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: e758a64e80f54439913241f9aa537127 postedOn: '2023-03-27 17:41:03' reasonCode: Correcting invoice error referredCreditMemoId: null referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Posted success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: e758a64e80f54439913241f9aa537127 updatedDate: '2023-03-27 17:41:03' schema: $ref: '#/components/schemas/GETDebitMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Post a debit memo tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/taxationitems: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates taxation items for a debit memo. operationId: POST_DM_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemListForDMType' required: true responses: '200': content: application/json: examples: response: value: success: true taxationItems: - createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:27:20' exemptAmount: 0 financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a7e9791015a87b17cee0076 jurisdiction: CALIFORNIA locationCode: '06' memoItemId: 402890555a7e9791015a87b082980068 name: STATE TAX sourceTaxItemId: 402890555a7d4022015a7db254e200c2 taxAmount: 0.01 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-06-05' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:27:20' - createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:27:20' exemptAmount: 0 financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a7e9791015a87b17cf10077 jurisdiction: CALIFORNIA locationCode: '06' memoItemId: 402890555a7e9791015a87b082d5006a name: STATE TAX taxAmount: 0.02 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-06-05' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:27:20' schema: $ref: '#/components/schemas/GETTaxationItemListType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create taxation items for a debit memo tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/unpost: put: description: |- **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Unposts a debit memo that is in Posted status. If any credit memo or payment has been applied to a debit memo, you are not allowed to unpost the debit memo. After a debit memo is unposted, its status becomes Draft. You can unpost debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). You can prevent an unpost operation by configuring the 'Do not allow unposting invoices and memos if their revenue is already recognized in a closed accounting period' accounting rule. The default value of this rule is set to 'disabled.' For more information, see [Configure Accounting Rules](https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance/D_Finance_Settings/D_Configure_Accounting_Rules#Do_not_allow_unposting_invoices_and_memos_if_their_revenue_is_already_recognized_in_a_closed_accounting_period). operationId: PUT_UnpostDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722f3af193744 accountNumber: AN_Test11679918607694 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: c24f12918d5b45d0b7f9da297b8b7a9d createdDate: '2023-03-27 17:33:29' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 4028ab1f87121698018722f3b60c375b invoiceGroupNumber: N-0001 latestPDFFileId: 4028ab1f87121698018722f3bb0b376b number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: null referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: c24f12918d5b45d0b7f9da297b8b7a9d updatedDate: '2023-03-27 17:33:42' schema: $ref: '#/components/schemas/GETDebitMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Unpost a debit memo tags: - Debit Memos /v1/invoices/{invoiceKey}/debitmemos: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates an ad-hoc debit memo from an invoice. You can create a debit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. operationId: POST_DebitMemoFromInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of an invoice that you want to create a debit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001. in: path name: invoiceKey required: true schema: type: string - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoFromInvoiceRequest' required: true responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018712fb22312b70 accountNumber: AN_Test11679650660490 amount: 1 autoPay: true balance: 1 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: the comment createdById: bd19d326bce5465c81df19d3262954c3 createdDate: '2023-03-24 15:08:37' currency: USD debitMemoDate: '2023-04-29' dueDate: '2023-04-29' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: null id: 4028ab1f87121698018712fc005a2ba7 invoiceGroupNumber: N-0001 latestPDFFileId: null number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: null referredInvoiceId: 4028ab1f87121698018712fb2a3b2b91 sequenceSetId: null soldToContactId: null soldToContactSnapshotId: null sourceType: Invoice status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: null totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: bd19d326bce5465c81df19d3262954c3 updatedDate: '2023-03-24 15:08:37' schema: $ref: '#/components/schemas/GETDebitMemoType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a debit memo from an invoice tags: - Debit Memos /v1/debitmemos/{debitMemoKey}/write-off: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Writes off a debit memo. By writing off a debit memo, a credit memo is automatically created and applied to the debit memo. The generated credit memo items and credit memo taxation items are applied to the corresponding debit memo items and debit memo taxation items respectively. **Note**: * This API operation is available only if you have enabled the enhanced write-off permission for your tenant. Contact Zuora Global Support to enable this permission. * The total amount must be equal to the amount entered at the invoice item level. * If the non revenue impact value is set to Yes, then the non revenue write off accounting code must be specified. operationId: PUT_WriteOffDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: debitMemoKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTWriteOffDebitMemoRequest' required: true responses: '200': content: application/json: examples: response: value: creditMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PUTWriteOffDebitMemoResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Write off a debit memo tags: - Debit Memos /v1/einvoice/service-providers: get: description: | Lists information about e-invoicing service providers. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingServiceProviders parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' responses: '200': content: application/json: examples: response: value: serviceProviders: - id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'false' companyIdentifier: CompanySample1 schema: $ref: '#/components/schemas/ListEInvoicingServiceProvidersResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List e-invoicing service providers tags: - E-Invoicing post: description: | Creates an e-invoicing service provider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: POST_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEInvoicingServiceProviderRequest' required: true responses: '200': content: application/json: examples: response: value: id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'false' companyIdentifier: CompanySample1 apiKey: SampleApiKey clientCertificate: U3dhZ2dlciByb2Nrcw== clientCertificateType: PKCS12 schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create an e-invoicing service provider tags: - E-Invoicing /v1/einvoice/service-providers/{key}: delete: description: | Deletes an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: DELETE_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoicing service provider that you want to in: path name: key required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete an e-invoicing service provider tags: - E-Invoicing get: description: | Retrieves information about an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoicing service provider that you want to retrieve information about. in: path name: key required: true schema: type: string responses: '200': content: application/json: examples: response: value: id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'false' companyIdentifier: CompanySample1 schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve an e-invoicing service provider tags: - E-Invoicing put: description: | Updates information about an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_UpdateEInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoicing service provider that you want to update. in: path name: key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoicingServiceProviderRequest' required: true responses: '200': content: application/json: examples: response: value: id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'true' companyIdentifier: CompanySample1 apiKey: SampleApiKey clientCertificate: U3dhZ2dlciByb2Nrcw== clientCertificateType: PKCS12 schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update an e-invoicing service provider tags: - E-Invoicing /v1/einvoice/business-regions: get: description: | Lists information about e-invoicing business regions. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingBusinessRegions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' responses: '200': content: application/json: examples: response: value: regions: - addressLine1: '' addressLine2: '' businessName: legal business name businessNumber: '20002039' businessNumberSchemaId: '88' businessRegionNumber: EIBR-00000008 city: Tokyo contactName: '' country: JP digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: '' endpointId: '8992' endpointSchemeId: '88' phoneNumber: '' postalCode: '368779' responseMapping: {} serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: '' taxRegisterNumber: TAX393999 tradeName: Zuora - addressLine1: '' addressLine2: '' businessName: legal business name businessNumber: '20002039' businessNumberSchemaId: '88' businessRegionNumber: EIBR-00000006 city: Paris contactName: '' country: FR digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: '' endpointId: '8992' endpointSchemeId: '88' phoneNumber: '' postalCode: '368779' responseMapping: {} serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: '' taxRegisterNumber: TAX393999 tradeName: Zuora success: true schema: $ref: '#/components/schemas/ListEInvoicingBusinessRegionsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List e-invoicing business regions tags: - E-Invoicing post: description: | Creates an e-invoicing business region. You must create business regions to store the business detail information as a seller. If you have multiple GSTINs for different states, you can create multiple business region objects for India. The business region objects can be looked up according to the country and state, and its related fields can be mapped accordingly within the e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: POST_CreateEInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEInvoicingBusinessRegionRequest' required: true responses: '200': content: application/json: examples: response: value: addressLine1: '' addressLine2: '' businessName: legal business name businessNumber: '20002039' businessNumberSchemaId: '88' businessRegionNumber: EIBR-00000002 city: Tokyo contactName: '' country: JP digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: '' id: 4028b2aa8890c524018890c7e9ef3826 phoneNumber: '' postalCode: '368779' responseMapping: {} serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: '' taxRegisterNumber: TAX393999 tradeName: Zuora schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create an e-invoicing business region tags: - E-Invoicing /v1/einvoice/business-regions/{key}: delete: description: | Deletes an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: DELETE_EInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unqiue ID or number of the e-invoicing business region that you want to delete. in: path name: key required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete an e-invoicing business region tags: - E-Invoicing get: description: | Retrieves information about an e-invoicing business region. You can search for an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unqiue ID or number of the e-invoicing business region that you want to retrieve information about. in: path name: key required: true schema: type: string responses: '200': content: application/json: examples: response: value: addressLine1: '' addressLine2: '' businessName: legal business name businessNumber: '20002039' businessNumberSchemeId: '88' businessRegionNumber: EIBR-00000002 city: Rome contactName: '' country: IT digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: '' endpointId: '8992' endpointSchemeId: '88' id: 8a90f508885201ad018856a2d9070163 phoneNumber: '' postalCode: '368779' responseMapping: {} serviceProviderId: 8a90876c8851d877018855e81a6b710d state: '' success: true taxRegisterNumber: TAX393999 tradeName: Zuora schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve an e-invoicing business region tags: - E-Invoicing put: description: | Updates an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_UpdateEInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unqiue ID or number of the e-invoicing business region that you want to update. in: path name: key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoicingBusinessRegionRequest' required: true responses: '200': content: application/json: examples: response: value: addressLine1: null addressLine2: null businessName: legal business name businessNumber: '20002039' businessNumberSchemaId: '88' businessRegionNumber: EIBR-00000002 city: Tokyo contactName: null country: JP digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: null endpointId: '8992' endpointSchemeId: '88' phoneNumber: null postalCode: '368779' responseMapping: {} serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: null taxRegisterNumber: TAX393999 tradeName: Zuora schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update an e-invoicing business region tags: - E-Invoicing /v1/einvoice/templates: get: description: | Lists information about e-invoice file templates. You can query e-invoice file templates by conditions. For example, if your service provider is Sovos, you can use the following example URL to retrieve information about a list of e-invoice file templates for invoices in India: `/v1/einvoice/templates?country=IN&documentType=Invoice&provider=Sovos` **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoiceFileTemplates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The short name of a country or region where you must comply with e-invoicing requirements. For example, `IN` for India. For the full list of country names and codes, see View countries or regions. in: query name: country required: true schema: type: string - description: | The type of billing documents for which the e-invoice file template is intended. in: query name: documentType required: true schema: enum: - Invoice - CreditMemo - DebitMemo type: string - description: | The name of the e-invoicing service provider that assists in generating e-invoice files. in: query name: provider required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true templates: - country: SA documentType: Invoice id: 402833ec89d46b390189d51402d937b0 name: EInvoice Template Name provider: Sovos templateNumber: EITEMP-00000006 - country: SA documentType: CreditMemo id: 402833ec89d46b390189d514030537b2 name: EInvoice Template Name provider: Sovos templateNumber: EITEMP-00000008 - country: SA documentType: DebitMemo id: 402833ec89d46b390189d514032037b4 name: EInvoice Template Name provider: Sovos templateNumber: EITEMP-00000009 schema: $ref: '#/components/schemas/ListEInvoiceFileTemplatesResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List e-invoice file templates tags: - E-Invoicing post: description: | Creates an e-invoice file templates for your billing documents, including invoices, credit memos, and debit memos. Zuora provides default e-invoice file templates, so you can just customize them as needed. For example, some country specific fields like HSN (Harmonized System of Nomenclature) might be stored on product rate plan charges. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: POST_CreateEInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEInvoiceFileTemplateRequest' required: true responses: '200': content: application/json: examples: response: value: content: base64 encoded content country: IN documentType: Invoice id: 4028818484f483d20184f5006b97003f name: Sovos e-invoice service provider: Sovos success: true templateNumber: EITEMP-00000003 schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create an e-invoice file template tags: - E-Invoicing /v1/einvoice/templates/{key}: delete: description: | Deletes an e-invoice file template by key. The key can be the unique ID or number of an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: DELETE_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoice file template that you want to delete. in: path name: key required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete an e-invoice file template tags: - E-Invoicing get: description: | Retrieves information about an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the e-invoice file template that you want to retrieve information about. in: path name: key required: true schema: type: string responses: '200': content: application/json: examples: response: value: content: base64 encoded content country: IN documentType: Invoice id: 4028818484f483d20184f5006b97003f name: Sovos e-invoice service provider: Sovos success: true templateNumber: EITEMP-00000003 schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve an e-invoice file template tags: - E-Invoicing put: description: | Updates information about an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the e-invoice file template that you want to update. in: path name: key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoiceFileTemplateRequest' required: true responses: '200': content: application/json: examples: response: value: content: base64 encoded content country: IN documentType: Invoice id: 4028818484f483d20184f5006b97003f name: Sovos e-invoice service provider: Sovos success: true templateNumber: EITEMP-00000003 schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update an e-invoice file template tags: - E-Invoicing /v1/invoice-schedules: post: description: | Creates an invoice schedule. ### Limitations This API operation has the following limitations: * You can create at most 50 invoice schedule items in one request. * You can associate at most 10 orders with an invoice schedule in one request. * You can associate at most 300 subscriptions with an invoice schedule in one request, including those contained in orders and separate subscriptions. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: POST_CreateInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateInvoiceScheduleRequest' required: true responses: '200': content: application/json: examples: response: value: actualAmount: 70200 additionalSubscriptionsToBill: - S-00000001 - S-00000002 billedAmount: 0 currency: USD id: e2441b3e24eb42859194be7da2403b38 invoiceSeparately: false nextRunDate: '2022-02-24' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 50000 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 percentage: null runDate: '2022-02-24' status: Pending targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: Pending success: true totalAmount: 70200 unbilledAmount: 70200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}: delete: description: | Deletes an invoice schedule in Pending status. The status of the invoice schedule to be deleted must be `Pending`. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: DELETE_InvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the invoice schedule to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete an invoice schedule tags: - Invoice Schedules get: description: | Retrieves detailed information about an invoice schedule. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: GET_InvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of the invoice schedule to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: actualAmount: 20200 additionalSubscriptionsToBill: - S-00000001 - S-00000002 billedAmount: 50000 currency: USD id: e2441b3e24eb42859194be7da2403b38 invoiceSeparately: false nextRunDate: '2022-10-17' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 0 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 invoiceId: 8a8881aa82118bec018211dafc1e1695 percentage: null runDate: '2022-02-24' status: Processed targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: PartiallyProcessed success: true totalAmount: 70200 unbilledAmount: 20200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve an invoice schedule tags: - Invoice Schedules put: description: | Updates a pending invoice schedule. You can use this API operation to update invoice schedules in the following aspects: - Update notes and pending invoice schedule items - Update orders associated with invoice schedules - Remove or add invoice schedule items For more samples, see Edit invoice schedules ### Restrictions and limitations When updating invoice schedules through the REST API, keep the following restrictions and limitations in mind: - You can only update invoice schedule items in `Pending` status. - You can only add orders or specific subscriptions to pending invoice schedules, and remove orders or specific subscriptions from pending invoice schedules. - For the invoice schedule items that you want to update, you must include the new values for these items in the request. - For the invoice schedule items that you want to keep unchanged, you must include all the existing information about these items in the request. Otherwise, the existing invoice schedule items that you do not include in the request are deleted. - For the orders that you want to keep unchanged for an invoice schedule, you must include all the existing order numbers associated with the invoice schedule in the request. Otherwise, the existing orders that you do not include in the request are removed. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: PUT_UpdateInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the invoice schedule to be updated. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTUpdateInvoiceScheduleRequest' required: true responses: '200': content: application/json: examples: response: value: actualAmount: 70200 additionalSubscriptionsToBill: - S-00000001 - S-00000002 billedAmount: 0 currency: USD id: e2441b3e24eb42859194be7da2403b38 invoiceSeparately: false nextRunDate: '2022-02-24' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 54000 amount: 54000 id: 8a8881aa82118bec018211daf9f01680 percentage: null runDate: '2022-02-24' status: Pending targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 10000 amount: 10000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: Pending success: true totalAmount: 70200 unbilledAmount: 70200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/execute: post: description: | Executes an invoice schedule immediately. During the execution, a bill run is created and generates an invoice or a credit memo asynchronously. When you use this API operation to execute an invoice schedule item, you have the flexibility to decide whether to specify a specific item ID. - If you specify the unique ID of an invoice schedule item to be executed in the request, the corresponding invoice schedule item is executed. - If you do not specify the ID of any invoice schedule item in the request, the subscription end date is used as the target date to determine the next pending schedule item to be executed. A paused invoice schedule and charges inside cannot be automatically executed by Zuora Scheduler or by this "Execute an invoice schedule" API operation. In this case, you can do one of the following: - Use the Generate billing documents by account ID API operation - Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API For more samples, see [Execute invoice schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_tutorials/Execute_invoice_schedules). **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: POST_ExecuteInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTExecuteInvoiceScheduleRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExecuteInvoiceScheduleBillRunResponse' autoEmail: examples: response: value: false autoPost: examples: response: value: false autoRenewal: examples: response: value: false billRunFilters: examples: response: value: - accountId: 8ad09c4b82b5c6330182c5ccab3570e6 filterType: InvoiceSchedule billRunNumber: examples: response: value: BR-00001017 createdById: examples: response: value: 2c92c0f84298ac5901429dea196212be createdDate: examples: response: value: '2022-08-22 06:47:18' id: examples: response: value: 8ad0823f82b5b2520182c5cec5fe40fb invoiceDate: examples: response: value: '2022-02-24' noEmailForZeroAmountInvoice: examples: response: value: false status: examples: response: value: Pending success: examples: response: value: true targetDate: examples: response: value: '2022-02-24' updatedById: examples: response: value: 2c92c0f84298ac5901429dea196212be updatedDate: examples: response: value: '2022-08-22 06:47:18' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Execute an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/pause: put: description: | Pauses an invoice schedule immediately. A paused invoice schedule and charges inside cannot be automatically executed by Zuora Scheduler or by the Execute an invoice schedule API operation. In this case, you can do one of the following: - Use the Generate billing documents by account ID API operation - Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: PUT_PauseInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: actualAmount: 20200 billedAmount: 50000 currency: USD id: e2441b3e24eb42859194be7da2403b38 nextRunDate: '2022-10-17' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 0 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 invoiceId: 8a8881aa82118bec018211dafc1e1695 percentage: null runDate: '2022-02-24' status: Processed targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: Paused success: true totalAmount: 70200 unbilledAmount: 20200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Pause an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/resume: put: description: | Resumes an invoice schedule in Paused status immediately. After an invoice schedule is resumed, it can continue to be automatically executed by Zuora Scheduler or by the [Execute an invoice schedule](https://developer.zuora.com/api-references/api/operation/POST_ExecuteInvoiceSchedule/) API operation. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: PUT_ResumeInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the schedule to be resumed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: actualAmount: 20200 billedAmount: 50000 currency: USD id: e2441b3e24eb42859194be7da2403b38 nextRunDate: '2022-10-17' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 0 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 invoiceId: 8a8881aa82118bec018211dafc1e1695 percentage: null runDate: '2022-02-24' status: Processed targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: PartiallyProcessed success: true totalAmount: 70200 unbilledAmount: 20200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Resume an invoice schedule tags: - Invoice Schedules /v1/object/taxation-item: post: description: '' operationId: Object_POSTTaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateTaxationItem' required: true responses: '200': content: application/json: examples: response: value: Id: 2c93808457d787030157e0306f413a96 Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '400': content: application/json: examples: response: value: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Create a taxation item' tags: - Taxation Items /v1/taxationitems/{id}: delete: description: | Deletes a specific taxation item by ID. operationId: DELETE_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a taxation item. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a taxation item tags: - Taxation Items get: description: | Retrieves the information about a specific taxation item by ID. operationId: GET_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a taxation item. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-02-27 11:52:03' exemptAmount: 0 financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null salesTaxPayableAccountingCode: null salesTaxPayableAccountingCodeType: null id: 402890555a7d4022015a7db254e200c8 jurisdiction: null locationCode: null memoItemId: 402890555a7d4022015a7db254d800c7 name: my tax sourceTaxItemId: 402890555a7d4022015a7db254e200c1 success: true taxAmount: 1 taxCode: ZtaxCode taxCodeDescription: '' taxDate: '2017-02-27' taxRate: 5 taxRateDescription: null taxRateType: FlatFee updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-02-27 11:52:03' schema: $ref: '#/components/schemas/GETTaxationItemType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: | Retrieve a taxation item tags: - Taxation Items put: description: | Updates a specific taxation item by ID. operationId: PUT_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a taxation item. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTTaxationItemType' required: true responses: '200': content: application/json: examples: response: value: createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-02-27 18:16:24' exemptAmount: 0 financeInformation: onAccountAccountingCode: Check onAccountAccountingCodeType: Cash salesTaxPayableAccountingCode: null salesTaxPayableAccountingCodeType: null id: 402890555a7e9791015a7f12364e0004 jurisdiction: CALIFORNIA locationCode: '06' memoItemId: 402890555a7e9791015a7f1235f50003 name: STATE TAX sourceTaxItemId: 402890555a7d4022015a7db254e200c1 success: true taxAmount: 1 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-06-05' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-02-28 17:53:11' schema: $ref: '#/components/schemas/GETTaxationItemType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a taxation item tags: - Taxation Items /v1/sequence-sets: get: description: | Retrieves information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. You can use query parameters to restrict the data returned in the response. **Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: GET_SequenceSets parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The name or number of a specific sequence set. in: query name: name required: false schema: type: string responses: '200': content: application/json: examples: response: value: sequenceSets: - creditMemo: prefix: CM startNumber: 11 debitMemo: prefix: DM startNumber: 12 id: 2c98906c69be199c0169be74ed210afd invoice: prefix: INV startNumber: 10 name: DEFAULT payment: prefix: P- startNumber: 13 refund: prefix: R- startNumber: 14 - creditMemo: prefix: FCM startNumber: 11 debitMemo: prefix: FDM startNumber: 12 id: 2c98906c69be199c0169be74ed211afd invoice: prefix: FINV startNumber: 10 name: FR payment: prefix: FP- startNumber: 13 refund: prefix: FR- startNumber: 14 - creditMemo: prefix: ITACM startNumber: 11 debitMemo: prefix: ITADM startNumber: 12 id: 2c98906c69be199c0169be74ed212afd invoice: prefix: ITAINV startNumber: 10 name: ITA payment: prefix: ITAP- startNumber: 13 refund: prefix: ITAR- startNumber: 14 success: true schema: $ref: '#/components/schemas/GETSequenceSetsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List sequence sets tags: - Sequence Sets post: description: | Creates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. You can create a maximum of 100 sequence sets in one single request. A sequence set comprises a set of custom prefixes and starting numbers that are used for billing documents to generate, and payments and refunds to create. See [Prefix and Numbering Configuration for Billing Documents](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Prefix_and_Numbering_Configuration_for_Billing_Documents) for more information about limitations. **Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: POST_SequenceSets parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSequenceSetsRequest' required: true responses: '200': content: application/json: examples: response: value: sequenceSets: - creditMemo: prefix: FCM startNumber: 10 debitMemo: prefix: FDM startNumber: 10 id: 402892c74c9193cd014c96bbe7c101f9 invoice: prefix: FINV startNumber: 10 name: FR payment: prefix: FP- startNumber: 10 refund: prefix: FR- startNumber: 10 - creditMemo: prefix: ICM startNumber: 10 debitMemo: prefix: IDM startNumber: 10 id: 402892c74c9193cd014c96bbe7c201f9 invoice: prefix: IINV startNumber: 10 name: ITA payment: prefix: IP- startNumber: 10 refund: prefix: IR- startNumber: 10 success: true schema: $ref: '#/components/schemas/POSTSequenceSetsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create sequence sets tags: - Sequence Sets /v1/sequence-sets/{id}: delete: description: | Deletes a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. **Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: DELETE_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the sequence set to delete. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a sequence set tags: - Sequence Sets get: description: | Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos **Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: GET_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the sequence set to retrieve information about. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: creditMemo: prefix: FCM startNumber: 11 debitMemo: prefix: FDM startNumber: 12 invoice: prefix: FINV startNumber: 10 name: FR payment: prefix: FP- startNumber: 13 refund: prefix: FR- startNumber: 14 success: true schema: $ref: '#/components/schemas/GETSequenceSetResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a sequence set tags: - Sequence Sets put: description: | Updates a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. **Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: PUT_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the sequence set to update. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSequenceSetRequest' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/PUTSequenceSetResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a sequence set tags: - Sequence Sets /v1/operations/billing-preview: post: description: | Generates a preview of future invoice items for one customer account. Use the BillingPreview call to calculate how much a single customer will be invoiced from the most recent invoice to a specific end of term date in the future. Additionally, you can use the BillingPreview service to access real-time data on an individual customer's usage consumption. The BillingPreview call only calculates taxes for charges in the subscription if you use [Zuora Tax](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax) and the product rate plan charge associated with the invoice item uses the [tax inclusive mode](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax/D_Associate_tax_codes_with_product_charges_and_set_the_tax_mode); otherwise, this call does not calculate taxes. If you have the Invoice Settlement feature enabled, you can also generate a preview of future credit memo items for one customer account. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. operationId: POST_BillingPreview parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostBillingPreviewParam' required: true responses: '200': content: application/json: examples: response: value: accountId: 8ad09bce83f1da020183f97e245c1c47 invoiceItems: - id: d573746814a14da0a0a0abda2a41d65a subscriptionName: A-S00000346 subscriptionId: 8ad08ad58e35d490018e36a0f1ca2a9c subscriptionNumber: A-S00000346 serviceStartDate: '2024-08-01' serviceEndDate: '2024-08-31' chargeAmount: 10 chargeDescription: '' chargeName: Monthly Fee chargeNumber: C-00000950 chargeId: 8ad08ad58e35d490018e36a0f2252aa5 productName: Music service quantity: 1 taxAmount: 0 unitOfMeasure: '' chargeDate: '2024-07-09 17:06:58' chargeType: Recurring processingType: Charge appliedToItemId: null numberOfDeliveries: 0 - id: c86c42ee4f5b42bd86351f4a99bf230e subscriptionName: A-S00000346 subscriptionId: 8ad08ad58e35d490018e36a0f1ca2a9c subscriptionNumber: A-S00000346 serviceStartDate: '2024-09-01' serviceEndDate: '2024-09-30' chargeAmount: 10 chargeDescription: '' chargeName: Monthly Fee chargeNumber: C-00000950 chargeId: 8ad08ad58e35d490018e36a0f2252aa5 productName: Music service quantity: 1 taxAmount: 0 unitOfMeasure: '' chargeDate: '2024-07-09 17:06:58' chargeType: Recurring processingType: Charge appliedToItemId: null numberOfDeliveries: 0 success: true schema: $ref: '#/components/schemas/BillingPreviewResult' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Generate a billing preview tags: - Operations /v1/operations/invoice-collect: post: description: | Generates and posts invoices and credit memos and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement feature enabled and negative charges exist. Credit memos will not be applied to invoices. If draft invoices and credit memos exist when you run this operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan charge will not be posted. You can use this operation to generate invoices and collect payments on the posted invoices, or else simply collect payment on a specified existing invoice. The customer's default payment method is used, and the full amount due is collected. The operation depends on the parameters you specify. - To generate one or more new invoices for that customer and collect payment on the generated and other unpaid invoice(s), leave the **invoiceId** field empty. - To collect payment on an existing invoice, specify the invoice ID. The operation is atomic; if any part is unsuccessful, the entire operation is rolled back. When an error occurs, gateway reason codes and error messages are returned the error response of this operation. The following items are some gateway response code examples. - Orbital: `05 Do Not Honor`; `14 Invalid Credit Card Number` - Vantiv: `301 Invalid Account Number`; `304 Lost/Stolen Card` - CyberSource2: `202 Expired card`; `231 Invalid account number` For more reason code information, see the corresponding payment gateway documentation. ### Notes Timeouts may occur when using this method on an account that has an extremely high number of subscriptions. operationId: POST_TransactionInvoicePayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTInvoiceCollectType' required: true responses: '200': content: application/json: examples: response: value: amountCollected: 801.73 creditMemos: - id: 402890555a7e9791015a879f064a0054 totalAmount: 801.73 memoNumber: CM00000012 invoices: - invoiceAmount: 801.73 invoiceId: 4028925a4cb74ec9014cb7540988002e invoiceNumber: INV00000091 paymentId: 402892053e100406013e1024ab7c00e3 success: true schema: $ref: '#/components/schemas/POSTInvoiceCollectResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Invoice and collect tags: - Operations /v1/operations/jobs/{jobId}: get: description: | Retrieves information about a specific operation job. Currently, you can only use this API operation to retrieve the status information about invoice deletion operation jobs. operationId: GET_OperationJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID of the operation job to retrieve information about. For example, 2c92c8955bd63cc1015bd7c151af02ab. in: path name: jobId required: true schema: type: string responses: '200': content: application/json: examples: response: value: id: 4028818484a949680184a95174cb0019 objectId: 4028818484a949680184a9510c960009 objectType: Invoice operationType: Delete status: Completed success: true schema: $ref: '#/components/schemas/GetOperationJobResponseType' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve an operation job tags: - Operations /v1/operations/bulk-pdf: post: description: | The background job that compresses large number of PDF(s) into ZIP files. For answers to frequently asked questions regarding exporting bulk PDF files, see Export Bulk PDF Files FAQs. operationId: Create_BulkPDFToZIPGeneration parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkPdfGenerationJobRequestType' required: true responses: '200': content: application/json: example: jobId: 402880de8ce7edc3018ce7f18404312a invalidIds: [] success: true schema: $ref: '#/components/schemas/POSTBulkPdfGenerationJobResponseType' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: processId: processId reasons: - code: '51580020' message: All Document IDs provided in this request were either invalid or the billing document is not available. success: false requestId: d4b8c683-04ff-407d-964a-a63ae7917483 schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Export bulk PDF files tags: - Operations x-accepts: application/json x-codegen-request-body-name: Request x-content-type: application/json /v1/operations/bulk-pdf/{jobId}: get: description: Retrieves information about the job which includes its status, message, and downloadable ZIP file URL link. operationId: Get_BulkPDFToZIPGeneration parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: The ID of the job for which information needs to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab in: path name: jobId required: true schema: type: string responses: '200': content: application/json: example: jobId: 2c92c8955bd63cc1015bd7c151af02ab jobName: BulkPDFGenerationJobV1 status: Completed stepStatus: PostProcessing fileUrls: - https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_1.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99 - https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_2.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99 createdOn: '2024-01-08 12:52:05' createdBy: caf630704a6f4100818601625ecffe0b success: true schema: $ref: '#/components/schemas/GETBulkpdfGenerationJobResponseType' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve information of a bulk PDF file generation job tags: - Operations x-accepts: application/json /v1/bill-runs: post: description: | Creates an ad-hoc bill run or a scheduled bill run. - Support to create ad-hoc or scheduled bill runs by batch - Support to create ad-hoc or scheduled bill runs for a single account (all subscriptions under this account) - Support to create a bill run by subscription (50 or less subscriptions under the same account) To use this operation, you must have the Create Bill Runs billing permission. **Restrictions and limitations** When using this operation to create bill runs, keep the following restrictions and limitations in mind: - When creating batch-level bill runs, you must specify `batches` and cannot specify `billRunFilters`. - When creating account-level bill runs, you must specify `billRunFilters` and cannot specify `batches`. Only one single account is allowed. - When creating subscription-level bill runs, you must specify `billRunFilters` and cannot specify `batches`. All subscriptions must belong to the same account. At most 50 subscriptions are allowed. - If more than 500 bill runs created through this operation are in `Pending` status, you cannot use this operation to create any more bill runs. operationId: POST_CreateBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateBillRunRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a bill run tags: - Bill Run /v1/bill-runs/{billRunId}: delete: description: | Deletes a bill run. You can only delete bill runs in `Canceled` or `Error` status. operationId: DELETE_DeleteBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a bill run. in: path name: billRunId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a bill run tags: - Bill Run get: description: | Retrieves the information about a specific bill run. operationId: GET_BillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a bill run. in: path name: billRunId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a bill run tags: - Bill Run /v1/bill-runs/{billRunId}/cancel: put: description: | Cancels a bill run in Draft status. When cancelling a scheduled bill run, keep the following information in mind: - If you set `cancelOnce` to `true`, only the current bill run is cancelled. The other future scheduled bill runs will be automatically executed based on the schedule. - If you set `cancelOnce` to `false`, all future recurring bill runs are cancelled. operationId: PUT_CancelBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a bill run. in: path name: billRunId required: true schema: type: string requestBody: content: application/json: schema: example: cancelOnce: true properties: cancelOnce: default: true description: | Whether to cancel the current bill run or cancel all future recurring bill runs, only valid for a scheduled bill run. type: boolean type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CancelBillRunResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Cancel a bill run tags: - Bill Run /v1/bill-runs/{billRunId}/post: put: description: | Posts a bill run asynchronously. To post a bill run, the current bill run must be in `Completed` status. When a bill run is being posted, its status is changed to `PostInProgress`. After all invoices for this bill run are posted, its status is changed to `Posted`. operationId: PUT_PostBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a bill run. in: path name: billRunId required: true schema: type: string requestBody: content: application/json: schema: example: invoiceDate: '2022-01-01' properties: invoiceDate: description: | The date that appears on the invoice being created, in `yyyy-mm-dd` format. The value cannot fall in a closed accounting period. format: date type: string required: - invoiceDate type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Post a bill run tags: - Bill Run /v1/bill-runs/{billRunKey}/emails: post: description: | Manually emails all the billing documents that are generated from a specified bill run to your customers. Bill runs can generate invoices and credit memos based on your [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos). Credit memos are only available if you have the Invoice Settlement feature enabled. Using this API operation, the billing documents are sent to the email addresses specified in the **To Email** field of the email templates. The email template used for each billing document is set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See [Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information about how to edit the **To Email** field in the email template. ### Notes - Even though no field is required in the Request body, you still need to specify `{}` in the request. Otherwise, an error will be returned. - You can only email posted billing documents. - You must activate the following notifications before emailing invoices and credit memos: - **Manual Email For Invoice | Manual Email For Invoice** - **Email Credit Memo | Manually email Credit Memo** - To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. To include the credit memo PDF in the email, select the **Include Credit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information. - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the following templates are used for billing documents: - Invoices: **Invoice Posted Default Email Template** - Credit memos: **Manual Email for Credit Memo Default Template** See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. operationId: POST_EmailBillingDocumentsfromBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the bill run. For example, 2c92c8f95d0c886e015d11287a8f0f8b or BR-00000001. in: path name: billRunKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTEmailBillingDocfromBillRunType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Email billing documents generated from a bill run tags: - Bill Run /v1/billing-preview-runs: post: description: | Creates a billing preview run for multiple customer accounts. The maximum supported preview duration is 20 years, calculated from the current date to the target date. You can run up to 20 billing preview runs in batches concurrently. A single batch of customer accounts can only have one billing preview run at a time. So you can have up to 20 batches running at the same time. If you create a billing preview run for all customer batches, you cannot create another billing preview run until this preview run is completed. Note that the preview results for each billing preview run will be stored in the system for 180 days; after that they will be purged. operationId: POST_BillingPreviewRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PostBillingPreviewRunParam' required: true responses: '200': content: application/json: examples: response: value: billingPreviewRunId: 402890b757d1ec1b0157d5aa3d6802aa success: true schema: properties: billingPreviewRunId: description: | Id of the billing preview run. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a billing preview run tags: - Billing Preview Run /v1/billing-preview-runs/{billingPreviewRunId}: get: description: | Retrieves a preview of future invoice items for multiple customer accounts through a billing preview run. If you have the Invoice Settlement feature enabled, you can also retrieve a preview of future credit memo items. 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. A billing preview run asynchronously generates a downloadable CSV file containing a preview of invoice item data and credit memo item data for a batch of customer accounts. Note that if you set `storageOption` to `Database`, no CSV file is generate; instead, you can have a record in the billing preview result. You can use data source to query Billing Preview Run Result. operationId: GET_BillingPreviewRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: zuora-version required: false schema: type: string - description: | Id of the billing preview run. in: path name: billingPreviewRunId required: true schema: type: string responses: '200': content: application/json: examples: response: value: assumeRenewal: Autorenew batches: '' chargeTypeToExclude: OneTime createdById: 4028906d58240f960158241132be0003 createdDate: '2016-11-04 16:18:56' endDate: '2016-11-04 16:19:00' errorMessage: null includingDraftItems: false includingEvergreenSubscription: true resultFileUrl: https://rest.zuora.com/v1/files/4028906d582d21a101582e6b663c0a65 runNumber: BPR-00000010 startDate: '2016-11-04 16:19:00' status: Completed succeededAccounts: 7 success: true targetDate: '2016-12-01' totalAccounts: 7 updatedById: 4028906d58240f960158241132be0003 updatedDate: '2016-11-04 16:19:00' schema: $ref: '#/components/schemas/GetBillingPreviewRunResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a billing preview run tags: - Billing Preview Run /v1/payment-methods: post: description: | You can 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. To view the applicable fields for each payment method type, select the payment method type from the `type` list. The following types of the payment methods are supported: * `CreditCard` - Credit card payment method. * `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method. * `ACH` - ACH payment method. * `SEPA` - Single Euro Payments Area. * `Betalingsservice` - Direct Debit DK. * `Autogiro` - Direct Debit SE. * `Bacs` - Direct Debit UK. * `Becs` - Direct Entry AU. * `Becsnz` - Direct Debit NZ. * `PAD` - Pre-Authorized Debit. * `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance. * `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance. * `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance. * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance. * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. See [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay) for details. * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details. * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details. The fields marked as `required` must be specified when creating non-tokenized payment methods. For more information about the required fields for the tokenization of payment methods, see Create tokenized payment methods with existing tokens or account information. operationId: POST_PaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPaymentMethodRequest' required: true responses: '200': content: application/json: examples: response: value: id: 2c92a09650a7a80a0150ab50a5b746bd success: true schema: $ref: '#/components/schemas/POSTPaymentMethodResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a payment method tags: - Payment Methods /v1/payment-methods/decryption: post: description: | The decryption API endpoint can conditionally perform 4 tasks in one atomic call: * Decrypt Apple Pay Payment token * Create Credit Card Payment Method in Zuora with decrypted Apple Pay information * Create a stored credential profile within the Apple Pay payment method * Process Payment on a specified Invoice (optional) operationId: POST_PaymentMethodsDecryption parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPaymentMethodDecryption' required: true responses: '200': content: application/json: examples: response: value: paymentMethodId: 2c92c8f83dcbd8b1013dcce1d6a600ce success: true schema: $ref: '#/components/schemas/POSTPaymentMethodResponseDecryption' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create an Apple Pay payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}: delete: description: | Deletes a credit card payment method. If the specified payment method is the account's default payment method, the request will fail. In that case, you must first designate a different payment method for that customer to be the default. operationId: DELETE_PaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.) in: path name: payment-method-id required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Delete a payment method tags: - Payment Methods get: description: | This operation allows you to get the detailed information about a payment method. **Note:** This operation also supports retrieving the custom payment method created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service. operationId: GET_PaymentMethod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Unique ID of the payment method to update. in: path name: payment-method-id required: true schema: type: string responses: '200': content: application/json: examples: response: value: AA_PICKLIST__c: null accountHolderInfo: accountHolderName: John Smith addressLine1: ABC addressLine2: EFT city: Example City country: United States email: example@google.com phone: '86123456789' state: Example State zipCode: '844000' accountKey: 4028839f7ca29000017ca29c1ce8003f bankIdentificationNumber: '411111' cardBinInfo: brand: Visa cardClass: Credit productType: Consumer_Card issuer: JPMORGAN CHASE BANK N.A. issuingCountryCode: US cardNumber: '************1111' createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-11-15 18:59:08' creditCardType: Visa deviceSessionId: null existingMandate: null expirationMonth: 11 expirationYear: 2027 id: 4028839f7d26a155017d26af16ef0001 identityNumber: '97370192024' ipAddress: null isDefault: true lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-11-15 18:59:08' lastTransactionStatus: Approved mandateInfo: mitConsentAgreementRef: null mitConsentAgreementSrc: null mitProfileAction: null mitProfileAgreedOn: null mitProfileType: null mitTransactionId: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null status: Active success: true totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: CreditCard updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-15 18:59:08' useDefaultRetryRule: true schema: $ref: '#/components/schemas/GETPaymentMethodResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Retrieve a payment method tags: - Payment Methods put: description: | This operation allows you to update an existing payment method. The following fields in the request body can be updated for any payment method types: - `maxConsecutivePaymentFailures` - `paymentRetryWindow` - `useDefaultRetryRule` The following fields in the request body can be updated for any payment method types except for Credit Card Reference Transaction payment methods: - `authGateway` - `accountHolderInfo` - `gatewayOptions` - `ipAddress` - Custom fields The following fields in the request body can be updated only for Credit Card payment methods: - `expirationMonth` - `expirationYear` - `securityCode` The following field in the request body can be updated for Credit Card, Credit Card Reference Transaction, ACH, and Bank Transfer payment methods: - `mandateInfo` operationId: PUT_PaymentMethod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Unique ID of the payment method to update. in: path name: payment-method-id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTPaymentMethodRequest' required: true responses: '200': content: application/json: examples: response: value: id: 2c92c0f86c99b4eb016cae1ee301728f success: true schema: $ref: '#/components/schemas/PUTPaymentMethodResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Update a payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}/verify: put: description: | Sends an authorization request to the corresponding payment gateway to verify the payment method, even though no changes are made for the payment method. Supported payment methods are Credit Cards and Paypal. Zuora now supports performing a standalone zero dollar verification or one dollar authorization for credit cards. It also supports a billing agreement status check on PayPal payment methods. If a payment method is created by Hosted Payment Pages and is not assigned to any billing account, the payment method cannot be verified through this operation. operationId: PUT_VerifyPaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID of the payment method to be verified. in: path name: payment-method-id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTVerifyPaymentMethodType' required: true responses: '200': content: application/json: examples: response: value: paymentMethodId: 402890765d9ce329015da18034ee0057 success: true schema: $ref: '#/components/schemas/PUTVerifyPaymentMethodResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Verify a payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}/scrub: put: description: | This operation enables you to replace all sensitive data in a payment method, related payment method snapshot table, and four related log tables with dummy values that will be stored in Zuora databases. This operation will scrub the sensitive data and soft-delete the specified payment method at the same time. If you want to delete or anonymize personal data in Zuora, you must scrub the payment method before anonymizing the associated account and contact. See [Delete or anonymize personal data](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Responding_to_individual_requests_for_access%2C_correction%2C_and_deletion_of_data_under_applicable_privacy_laws#Edit_and_correct_personal_data) for more information. **Note:** In order to use this operation, you must ensure that the **Scrub Sensitive Data of Specific Payment Method payments** permission is enabled in your user role. Contact your tenant administrator if you want to enable this permission. See [Scrub Payment Methods](https://knowledgecenter.zuora.com/CB_Billing/L_Payment_Methods/Scrub_Payment_Methods) for more information. operationId: PUT_ScrubPaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID of the payment method where you want to scrub the sensitive data. in: path name: payment-method-id required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Scrub a payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}/balance: get: summary: Retrieve the balance of a bank account tags: - Payment Methods description: | Zuora supports Plaid's Auth and Balance products for ACH transactions. Auth authenticates account details before sending requests to the gateway, while Balance checks the real-time account balance before transactions. Use this API operation to implement the integration with Plaid Balance manually. Before you use this API operation, ensure that the support for Plaid Auth and Balance is enabled. For more information, see Enable the support for Plaid account validation solution. operationId: getBankAccountBalance parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The unique ID of the payment method, such as `40289f3291d2587b0191d280fa20012g`. in: path name: payment-method-id required: true schema: type: string format: uuid responses: '200': content: application/json: examples: response: value: success: true currency: USD availableBalance: 100 currentBalance: 110.55 schema: $ref: '#/components/schemas/GetBankAccountBalanceResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: Only ACH payment method is supported to check balance. requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string /v1/payment-methods/{payment-method-id}/profiles: get: description: | Retrieves the stored credential profiles within a payment method. operationId: GET_StoredCredentialProfiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | ID of a payment method. in: path name: payment-method-id required: true schema: type: string - description: | Specifies whether to retrieve all the stored credential profiles within the payment method. By default, Zuora returns only the stored credential profiles with `Agreed` or `Active` status. If you set this parameter to `true`, Zuora returns all the stored credential profiles. in: query name: includeAll schema: default: false type: boolean responses: '200': content: application/json: examples: response: value: profiles: - activatedOn: '2019-03-06 07:45:55' agreedOn: '2019-03-06 07:45:55' brand: Visa cancelledOn: '2019-03-13 07:52:16' consentAgreementRef: ACCT1338AgreementV1.pdf consentAgreementSrc: External expiredOn: null number: 1 paymentMethodId: 402881836953a3c7016953aec290000d status: Cancelled type: Recurring - activatedOn: '2019-03-13 07:55:08' agreedOn: '2019-03-13 07:55:08' brand: Visa cancelledOn: null consentAgreementRef: ACCT1338AgreementV2.pdf consentAgreementSrc: External expiredOn: null number: 2 paymentMethodId: 402881836953a3c7016953aec290000d status: Active type: Recurring success: true schema: $ref: '#/components/schemas/GetStoredCredentialProfilesResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List stored credential profiles of a payment method tags: - Payment Methods post: description: | Creates a stored credential profile within a payment method. The stored credential profile represents a consent agreement that you have established with a customer. When you use the payment method in a transaction, Zuora may include information from the stored credential profile to inform the payment processor that the transaction is related to your pre-existing consent agreement with the customer. operationId: POST_CreateStoredCredentialProfile parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | ID of a payment method. in: path name: payment-method-id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStoredCredentialProfileRequest' required: true responses: '200': content: application/json: examples: response: value: number: 3 paymentMethodId: 402881836953a3c7016953aec290000d success: true schema: $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a stored credential profile tags: - Payment Methods /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel: post: description: | Cancels a stored credential profile within a payment method. Cancelling the stored credential profile indicates that the stored credentials are no longer valid, per a customer request. You cannot reactivate the stored credential profile after you have cancelled it. operationId: POST_CancelStoredCredentialProfile parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | ID of a payment method. in: path name: payment-method-id required: true schema: type: string - description: | Number that identifies a stored credential profile within the payment method. in: path name: profile-number required: true schema: type: integer responses: '200': content: application/json: examples: response: value: number: 1 paymentMethodId: 402881836953a3c7016953aec290000d success: true schema: $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Cancel a stored credential profile tags: - Payment Methods x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" "https://rest.zuora.com/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel" /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire: post: description: | Expires a stored credential profile within a payment method. Expiring the stored credential profile indicates that the stored credentials are no longer valid, per an expiration policy in the stored credential transaction framework. You cannot reactivate the stored credential profile after you have expired it. operationId: POST_ExpireStoredCredentialProfile parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | ID of a payment method. in: path name: payment-method-id required: true schema: type: string - description: | Number that identifies a stored credential profile within the payment method. in: path name: profile-number required: true schema: type: integer responses: '200': content: application/json: examples: response: value: number: 2 paymentMethodId: 402881836953a3c7016953aec290000d success: true schema: $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Expire a stored credential profile tags: - Payment Methods x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" "https://rest.zuora.com/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire" /payment-methods/apple-pay/domains: get: description: | Use this operation to retrieve details of your domains that are already registered with Apple for Apple Pay button integration implemented through Zuora's JavaScript SDK. You can use `domainName` as the query parameter to restrict domains returned in the response. Specify a domain name and the registered domains containing the specified domain name will be returned. For more information about Zuora's JavaScript SDK for Apple Pay integration, see Set up Apple Pay through the JavaScript SDK approach. operationId: GET_ListApplePayDomains parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Specifies a domain name such as `zuora.com` and the registered domains containing the specified domain name will be returned. For example, `test1.zuora.com` and `test2.zuora.com` are two registered domains, but `zuora.com` is not registered. If you specify `zuora.com` in this query field, the data of `test1.zuora.com` and `test2.zuora.com` will be returned. in: query name: domainName schema: type: string responses: '200': content: application/json: examples: response: value: domains: - createdBy: 402881e522cf4f9b0122cf5d82860002 createdOn: '2023-07-05 00:44:51' domainName: testapplepay.zuora.com domainVerified: true id: 402881a38924ff1001892502da090021 updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedOn: '2023-07-05 00:44:51' - createdBy: 402881e522cf4f9b0122cf5d82860002 createdOn: '2023-07-04 01:02:12' domainName: test1.zuora.com domainVerified: false id: 402881a3891fe7b401891fec61d40036 updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedOn: '2023-07-04 01:02:12' success: true schema: $ref: '#/components/schemas/GETListApplePayDomainsResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List registered Apple Pay domains tags: - Payment Methods post: description: | Before adding Apple Pay to your checkout flow by integrating with the JavaScript SDK provided by Zuora, your domains that will show the Apple Pay button must be registered with Apple. Use this operation to register a domain. For more information about Zuora's JavaScript SDK for Apple Pay integration, see Set up Apple Pay through the JavaScript SDK approach. operationId: POST_RegisterApplePayDomain parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTRegisterApplePayDomainRequest' required: true responses: '200': content: application/json: examples: response: value: domainName: testapplepay.zuora.com domainVerified: true id: 402881a38924ff1001892502da090021 success: true schema: $ref: '#/components/schemas/POSTRegisterApplePayDomainResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Register an Apple Pay domain tags: - Payment Methods /payment-methods/apple-pay/domains/{id}: delete: description: | Use this operation to unregister a domain with Apple for Apple Pay button integration implemented through Zuora's JavaScript SDK. For more information about Zuora's JavaScript SDK for Apple Pay integration, see Set up Apple Pay through the JavaScript SDK approach. operationId: DELETE_UnregisterApplePayDomain parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the domain, such as `402881a38924ff1001892502da090021`. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/DELETEUnresigerApplePayDomainResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Unregister an Apple Pay domain tags: - Payment Methods /web-payments/sessions: post: description: | Use this operation to create a payment session on your server side. The response contains a token for the payment session data. In addition to the required `accountId` and `currency` fields, you can specify the following fields to define the payment flow mode as one of the following: - Create and save a payment method: - `processPayment`: `false` - `storePaymentMethod`: `true` - `amount` - Process a one-time payment without saving the payment method: - `processPayment`: `true` - `storePaymentMethod`: `false` - `amount` or `invoices` + `amount` - Process the first payment and save the payment method for subsequent recurring payments: - `processPayment`: `true` - `storePaymentMethod`: `true` - `amount` or `invoices` + `amount` For more information, see the following articles: - Payment Form Implementation Guide - Set up a payment method through JavaScript SDK integration operationId: POST_CreatePaymentSession parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreatePaymentSessionRequest' required: true responses: '200': content: application/json: examples: response: value: token: LTljuuLaDQnHxeVpWaX6zq2xY2FJ6sSE schema: $ref: '#/components/schemas/POSTCreatePaymentSessionResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a payment session tags: - Payment Methods /v1/object/payment-method-snapshot/{id}: get: description: | This REST API reference describes how to retrieve a Payment Method Snapshot. A Payment Method Snapshot is a copy of the particular Payment Method used in a transaction. If the Payment Method is deleted, the Payment Method Snapshot continues to retain the data used in each of the past transactions. ### Notes The following Payment Method fields are not available in Payment Method Snapshots: * `Active` * `AchAddress1` * `AchAddress2` * `CreatedById` * `CreatedDate` * `UpdatedById` * `UpdatedDate` The Payment Method Snapshot field `PaymentMethodId` is not available in Payment Methods. operationId: Object_GETPaymentMethodSnapshot parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object fields to return in: query name: fields required: false schema: type: string - description: Object id in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: AccountId: 2c93808457d787030157e0314c0945d4 BankIdentificationNumber: '411111' CompanyName: '' CreditCardAddress1: 312 2nd Ave W CreditCardCity: Seattle CreditCardCountry: United States CreditCardExpirationMonth: 12 CreditCardExpirationYear: 2020 CreditCardHolderName: Somebody CreditCardMaskNumber: '************1111' CreditCardPostalCode: '98119' CreditCardState: Washington CreditCardType: Visa Id: 2c93808457d787030157e0314f2245d8 IdentityNumber: '' IsCompany: false NumConsecutiveFailures: 0 PaymentMethodId: 2c93808457d787030157e0314e8145d7 PaymentMethodStatus: Active TotalNumberOfErrorPayments: 0 TotalNumberOfProcessedPayments: 0 Type: CreditCard UseDefaultRetryRule: true schema: $ref: '#/components/schemas/ProxyGetPaymentMethodSnapshot' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '404': content: application/json: examples: response: value: done: true records: {} size: 0 schema: $ref: '#/components/schemas/ProxyNoDataResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Retrieve a payment method snapshot' tags: - Payment Method Snapshots /v1/object/payment-method-transaction-log/{id}: get: description: '' operationId: Object_GETPaymentMethodTransactionLog parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object fields to return in: query name: fields required: false schema: type: string - description: Object id in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyGetPaymentMethodTransactionLog' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '404': content: application/json: examples: response: value: done: true records: {} size: 0 schema: $ref: '#/components/schemas/ProxyNoDataResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: 'CRUD: Retrieve a payment method transaction log' tags: - Payment Method Transaction Logs /v1/payment-method-updaters: get: description: | Retrieves the detailed information of all Payment Method Updater (PMU) instances on your tenant, except for American Express (AMEX). operationId: GET_PaymentMethodUpdaterInstances parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' responses: '200': content: application/json: examples: response: value: success: true updaters: - daysToUpdateBeforeBcd: 7 id: 418734b01fbb11ee821f0e4e5eec84cf isActive: true isDefault: true isTest: true processAssociatedGwOnly: true processAutopayDefaultPmOnly: true processMastercard: true processVisa: true updaterGatewayType: CyberSource updaterName: CyberSourceUpdater - daysToUpdateBeforeBcd: 8 id: 418739741fbb11ee821f0e4e5eec84cf isActive: true isDefault: false isTest: true processAssociatedGwOnly: true processAutopayDefaultPmOnly: true processMastercard: true processVisa: true updaterGatewayType: WorldPay updaterName: WorldPayUpdater schema: $ref: '#/components/schemas/GETPaymentMethodUpdaterInstancesResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: List Payment Method Updater instances tags: - Payment Method Updater /v1/payment-method-updaters/batches: post: description: | Creates a Payment Method Updater (PMU) batch asynchronously. PMU for American Express (AMEX) is not supported. operationId: POST_PaymentMethodUpdaterBatch parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPaymentMethodUpdaterBatchRequest' required: true responses: '200': content: application/json: examples: response: value: processId: CFF02E89CBBC584E reasons: - code: 70370120 message: '''updaterAccountId'' may not be empty.' requestId: 228fab35-add0-4538-9523-32ce55a009db success: false schema: $ref: '#/components/schemas/POSTPaymentMethodUpdaterResponse' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Create a Payment Method Updater batch asynchronously tags: - Payment Method Updater /v1/rsa-signatures: post: description: | The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. The POST rsa_signatures call generates and returns the required digital signature and token for a Payment Pages 2.0 form. You need to pass the generated signature to your client for it to access Payment Pages 2.0. This REST service should be used only when you implement Payment Pages 2.0. **Note:** To avoid potential credit card fraud attacks, you should secure your Payment Pages from being accessed by fraudulent users before you issue client-side digital signatures and tokens. See [Manage Token Issuance](https://knowledgecenter.zuora.com/CB_Billing/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Manage_Token_Issuance) for more information. **Troubleshooting tip:** After you use this operation to generate an RSA signature, if `signature` returns `null` but `token` is successfully returned, please limit the number of the fields in your request to make sure that the maximum length supported by the RSA signature algorithm is not exceeded. The calculation of the request length is determined by the number of the parameters, and the length of each of the parameter name and its value. operationId: POST_RSASignatures parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTRSASignatureType' required: true responses: '200': content: application/json: examples: response: value: key: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWRFTwxQOqaG4JDZSQF/NJWvCDoSXm3TYilNzoN8nBbuvhKa7SZBBS+VP6rFqcbIU38Fu+Rf09vqyYOxuasPJe7yhqeOiStWB/aCPLhwXBeKt37L/qkwpNOKb1FETtUgrc+UjbtT0pnl55wCfi+Ik//X5SQi0B+c0ei1DQv99qmPJJErrhnBtdxeaWAT0EYAo42AOQ5cp0UWDY6OdOYL6+RyFOUFIs1yEgtfg4VMMSpSOKBOhYclQYuSC7nBF5Cc18ydtzsBpf7l49gCLTFzG45NCDAocada8KihFNpGXbauV9V4EPRD4lofaXdsXJ5Tw8/+KCsrUlvIQI3vcEv9LQIDAQAB signature: VpCAFL2hHC2irxbhWYGLJmdBigjARsCStwHZiQ78z5LyVuBCFr2lkie0db/7E8n38MXaq12Ng5As5Qj+9Nhz6RBsSEWLod7c7hvwNI28OcgBZtcV/wscbWU69EP/+/XrQnF3ZUbHbqmcmhE8C/zNnc2zvHckfArroDW2HxxmATfMJS0xKUm5TrHi4tiILZVMYY1KIUqQTyuXV6uRWYzkqMkFkZDNCxSxf0XwzuBI/VOgTCmFZb0c3+bk/q6+7d/azFCrrg8C3dquCNJRfUeaBou+SLUa4TW3hV4rGd2zpvSrD/425x4qFNGV6JQ7wvIleIdrXU4qbh9nCmYoApMODA== success: true tenantId: '12270' token: E2BJEle7YrAlw93SjkaKthTmzMvXF341 schema: $ref: '#/components/schemas/POSTRSASignatureResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Generate an RSA signature tags: - RSA Signatures /v1/rsa-signatures/decrypt: post: description: | The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. You use rsa_signatures to generate the required digital signature and token for a Payment Pages 2.0 form, and then you use the decrypt REST service to decrypt the signature to validate the signature and key. This REST service should be used only when you implement Payment Pages 2.0. operationId: POST_DecryptRSASignatures parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTDecryptionType' required: true responses: '200': content: application/json: examples: response: value: decryptedSignature: /apps/publichostedpagelite.do#12270#tpyeSbjfUdpZpY4EMSCy7CrupvuhIdvM#1473658419005#2c92c0f855e2b4630155ec9e6a1b6eec publicKey: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWRFTwxQOqaG4JDZSQF/NJWvCDoSXm3TYilNzoN8nBbuvhKa7SZBBS+VP6rFqcbIU38Fu+Rf09vqyYOxuasPJe7yhqeOiStWB/aCPLhwXBeKt37L/qkwpNOKb1FETtUgrc+UjbtT0pnl55wCfi+Ik//X5SQi0B+c0ei1DQv99qmPJJErrhnBtdxeaWAT0EYAo42AOQ5cp0UWDY6OdOYL6+RyFOUFIs1yEgtfg4VMMSpSOKBOhYclQYuSC7nBF5Cc18ydtzsBpf7l49gCLTFzG45NCDAocada8KihFNpGXbauV9V4EPRD4lofaXdsXJ5Tw8/+KCsrUlvIQI3vcEv9LQIDAQAB signature: BeNYuHFkp/sbfm3clYyCkKEqd7XVTRDOJ1/5rL0tpkqxiSq+maqYkDz5kA+lN64ipoefQuJ7Rdm5TpICErufeJfa2sfTmGARDJ0hr+StXfLsIxHmDoNH5dqcXv3W6MR4kaljEqPVuhzGQ0We98DG52JcHWqqN53oHwTyuZuXocQqnmiE23IPm8UrU3g4hX/OLat0R81wDQ1SslZ+4pnqlncpTpopCK4FxeG3B0gYMhZcYd17Cmf0N3tEHVXHDlJIm4rOx0OVT+YBnjbKYLM0jxYu7PRKRis+yzN1BoappOEB0gmPjznIeiYF0u/fJdZWoEwK7d9mrfJeOBbpFyRoHA== success: true schema: $ref: '#/components/schemas/POSTDecryptResponseType' description: '' headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' schema: maxLength: 64 type: string summary: Decrypt an RSA signature tags: - RSA Signatures /v1/hostedpages: get: description: | Returns the Payment Pages configuration metadata, specifically, page ID, page version, payment method type. The following are the version-specific and general REST requests for Payment Pages: * The request for Payment Pages 2.0 configuration information: `GETthe account
Example Co. Ltd.
emailHeaders: My-Header-1: Header value 1 My-Header-2: Header value 2 emailSubject: Accountthe invoice
Example Co. Ltd.
emailHeaders: My-Header-1: Header value 1 My-Header-2: Header value 2 emailSubject: Invoicethe account
Example Co. Ltd.
emailHeaders: My-Header-1: Header value 1 My-Header-2: Header value 2 emailSubject: AccountNote: 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.
Lists amendments. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryAmendments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - code - effectivedate - effectivepolicy - name - newrateplanid - removedrateplanid - status - subscriptionid - type - subtype - updateddate - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Amendment object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - code - effectivedate - effectivepolicy - name - newrateplanid - removedrateplanid - status - subscriptionid - type - subtype - updateddate responses: '200': content: application/json: schema: type: object title: QueryAmendmentsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedAmendment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/amendments/{key}: get: summary: Retrieve an amendment description: |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.
Retrieve the details of a specific Amendment object. operationId: queryAmendmentByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Amendment object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedAmendment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/billing-runs: get: summary: List bill runs description: | Lists bill runs. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryBillingRuns parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - createdbyid - updateddate - billingrunnumber - executeddate - name - numberofaccounts - numberofinvoices - numberofcreditmemos - status - targetdate - batches - repeattype - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Bill Run object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - createdbyid - updateddate - billingrunnumber - executeddate - name - numberofaccounts - numberofinvoices - numberofcreditmemos - status - targetdate - batches - repeattype responses: '200': content: application/json: schema: type: object title: QueryBillingRunsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedBillingRun' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/billing-runs/{key}: get: summary: Retrieve a bill run description: | Retrieve the details of a specific Bill Run object. operationId: queryBillingRunByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Bill Run object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedBillingRun' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/contacts: get: summary: List contacts description: | Lists contacts. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryContacts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - country - firstname - lastname - personalemail - workemail - workphone - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Contact object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - country - firstname - lastname - personalemail - workemail - workphone responses: '200': content: application/json: schema: type: object title: QueryContactsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedContact' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/contacts/{key}: get: summary: Retrieve a contact description: | Retrieve the details of a specific Contact object. operationId: queryContactByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Contact object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedContact' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memos: get: summary: List credit memos description: | Lists credit memos. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryCreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - balance - einvoicestatus - memodate - memonumber - sourcetype - status - totalamount - invoiceid - accountid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - billtocontact - creditmemoitems - creditmemoitems.subscription - creditmemoitems.subscription.account - creditmemoapplications description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - balance - einvoicestatus - memodate - memonumber - sourcetype - status - totalamount - invoiceid - accountid responses: '200': content: application/json: schema: type: object title: QueryCreditMemosResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedCreditMemo' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memos/{key}: get: summary: Retrieve a credit memo description: | Retrieve the details of a specific Credit Memo object. operationId: queryCreditMemoByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - billtocontact - creditmemoitems - creditmemoitems.subscription - creditmemoitems.subscription.account - creditmemoapplications description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedCreditMemo' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memo-applications: get: summary: List credit memo applications description: | Lists credit memo applications. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryCreditMemoApplications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - effectivedate - accountid - applicationgroupid - debitmemoid - invoiceid - in: query name: expand[] required: false schema: type: array items: type: string enum: - creditmemo description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - effectivedate - accountid - applicationgroupid - debitmemoid - invoiceid responses: '200': content: application/json: schema: type: object title: QueryCreditMemoApplicationsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedCreditMemoApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memo-applications/{key}: get: summary: Retrieve a credit memo application description: | Retrieve the details of a specific Credit Memo Application object. operationId: queryCreditMemoApplicationByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - creditmemo description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedCreditMemoApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memo-items: get: summary: List credit memo items description: | Lists credit memo items. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryCreditMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - excludeitembillingfromrevenueaccounting - sourceitemtype - chargenumber - subscriptionid - subscriptionnumber - invoiceitemid - rateplanchargeid - creditmemoid - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - rateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - excludeitembillingfromrevenueaccounting - fulfillmentid - orderlineitemid - sourceitemtype - chargenumber - subscriptionid - subscriptionnumber - invoiceitemid - rateplanchargeid - creditmemoid responses: '200': content: application/json: schema: type: object title: QueryCreditMemoItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedCreditMemoItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/credit-memo-items/{key}: get: summary: Retrieve a credit memo item description: | Retrieve the details of a specific Credit Memo Item object. operationId: queryCreditMemoItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - rateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedCreditMemoItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/debit-memos: get: summary: List debit memos description: | Lists debit memos. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryDebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - balance - creditmemoid - einvoicestatus - memodate - memonumber - sourcetype - status - totalamount - invoiceid - accountid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - billtocontact - debitmemoitems - debitmemoitems.subscription - debitmemoitems.subscription.account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - balance - creditmemoid - einvoicestatus - memodate - memonumber - sourcetype - status - totalamount - invoiceid - accountid responses: '200': content: application/json: schema: type: object title: QueryDebitMemosResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedDebitMemo' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/debit-memos/{key}: get: summary: Retrieve a debit memo description: | Retrieve the details of a specific Debit Memo object. operationId: queryDebitMemoByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - billtocontact - debitmemoitems - debitmemoitems.subscription - debitmemoitems.subscription.account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedDebitMemo' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/debit-memo-items: get: summary: List debit memo items description: | Lists debit memo items. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryDebitMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - creditmemoitemid - excludeitembillingfromrevenueaccounting - sourceitemtype - chargenumber - subscriptionid - subscriptionnumber - invoiceitemid - productrateplanchargeid - rateplanchargeid - debitmemoid - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - rateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - creditmemoitemid - excludeitembillingfromrevenueaccounting - sourceitemtype - chargenumber - subscriptionid - subscriptionnumber - invoiceitemid - productrateplanchargeid - rateplanchargeid - debitmemoid responses: '200': content: application/json: schema: type: object title: QueryDebitMemoItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedDebitMemoItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/debit-memo-items/{key}: get: summary: Retrieve a debit memo item description: | Retrieve the details of a specific Debit Memo Item object. operationId: queryDebitMemoItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - rateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedDebitMemoItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/invoices: get: summary: List invoices description: | Lists invoices. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - amount - balance - duedate - invoicedate - invoicenumber - reversed - sourceid - sourcetype - status - einvoicestatus - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - billtocontact - invoiceitems - invoiceitems.subscription - invoiceitems.subscription.account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - amount - balance - duedate - invoicedate - invoicenumber - reversed - sourceid - sourcetype - status - einvoicestatus responses: '200': content: application/json: schema: type: object title: QueryInvoicesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedInvoice' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/invoices/{key}: get: summary: Retrieve an invoice description: | Retrieve the details of a specific Invoice object. operationId: queryInvoiceByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - billtocontact - invoiceitems - invoiceitems.subscription - invoiceitems.subscription.account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedInvoice' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/invoice-items: get: summary: List invoice items description: | Lists invoice items. You can use the query parameters to filter, expand, and sort the returned results. **Note**: You must specify a `filter[]` query parameter to query invoice items. operationId: queryInvoiceItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - rateplanchargeid - invoiceid - accountingcode - chargedate - chargenumber - excludeitembillingfromrevenueaccounting - servicestartdate - sourceitemtype - subscriptionid - subscriptionnumber - productrateplanchargeid - bookingreference - in: query name: expand[] required: false schema: type: array items: type: string enum: - invoice - subscription - taxationitems - rateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: true schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - rateplanchargeid - invoiceid - accountingcode - chargedate - chargenumber - excludeitembillingfromrevenueaccounting - fulfillmentid - servicestartdate - sourceitemtype - subscriptionid - subscriptionnumber - productrateplanchargeid - bookingreference responses: '200': content: application/json: schema: type: object title: QueryInvoiceItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedInvoiceItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/invoice-items/{key}: get: summary: Retrieve an invoice item description: | Retrieve the details of a specific Invoice Item object. operationId: queryInvoiceItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - invoice - subscription - taxationitems - rateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedInvoiceItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/order-actions: get: summary: List order actions description: | Lists order actions. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryOrderActions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - subscriptionversionamendmentid - orderid - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - order description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - subscriptionversionamendmentid - orderid responses: '200': content: application/json: schema: type: object title: QueryOrderActionsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedOrderAction' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/order-actions/{key}: get: summary: Retrieve an order action description: | Retrieve the details of a specific Order Action object. operationId: queryOrderActionByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - order description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedOrderAction' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/order-line-items: get: summary: List order line items description: | Lists order line items. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryOrderLineItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - itemname - itemnumber - itemstate - itemtype - orderid - productcode - productrateplanchargeid - uom - relatedsubscriptionnumber - inlinediscounttype - in: query name: expand[] required: false schema: type: array items: type: string enum: - invoiceitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - itemname - itemnumber - itemstate - itemtype - orderid - productcode - productrateplanchargeid - billtoid - soldto - owneraccountid - invoiceowneraccountid - uom - relatedsubscriptionnumber - originalorderid - originalordernumber - originalorderlineitemid - inlinediscounttype responses: '200': content: application/json: schema: type: object title: QueryOrderLineItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedOrderLineItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/order-line-items/{key}: get: summary: Retrieve an order line item description: | Retrieve the details of a specific Order Line Item object. operationId: queryOrderLineItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - invoiceitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedOrderLineItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/orders: get: summary: List orders description: | Lists orders. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryOrders parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - orderdate - ordernumber - accountid - status - invoicescheduleid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - orderlineitems - orderlineitems.invoiceitems - orderactions - orderactions.subscription - orderactions.subscription.rateplans - orderactions.subscription.rateplans.rateplancharges description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - orderdate - ordernumber - accountid - status - invoicescheduleid responses: '200': content: application/json: schema: type: object title: QueryOrdersResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedOrders' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/orders/{key}: get: summary: Retrieve an order description: | Retrieve the details of a specific Order object. operationId: queryOrdersByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - orderlineitems - orderlineitems.invoiceitems - orderactions - orderactions.subscription - orderactions.subscription.rateplans - orderactions.subscription.rateplans.rateplancharges description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedOrders' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payments: get: summary: List payments description: | Lists payments. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPayments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - amount - effectivedate - gatewayorderid - gatewaystate - paymentmethodid - paymentmethodsnapshotid - paymentnumber - referenceid - source - sourcename - status - unappliedamount - createddate - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - account.billto - account.soldto - paymentmethod - paymentapplications description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - amount - effectivedate - gatewayorderid - gatewaystate - paymentmethodid - paymentmethodsnapshotid - paymentnumber - referenceid - source - sourcename - status - unappliedamount - createddate responses: '200': content: application/json: schema: type: object title: QueryPaymentsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPayment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payments/{key}: get: summary: Retrieve a payment description: | Retrieve the details of a specific Payment object. operationId: queryPaymentByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - account.billto - account.soldto - paymentmethod - paymentapplications description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPayment' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-applications: get: summary: List payment applications description: | Lists payment applications. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPaymentApplications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - effectivedate - accountid - paymentid - applicationgroupid - in: query name: expand[] required: false schema: type: array items: type: string enum: - payment description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - effectivedate - accountid - paymentid - applicationgroupid responses: '200': content: application/json: schema: type: object title: QueryPaymentApplicationsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-applications/{key}: get: summary: Retrieve a payment application description: | Retrieve the details of a specific Payment Application object. operationId: queryPaymentApplicationByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - payment description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-methods: get: summary: List payment methods description: | Lists payment methods. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - achaccountname - achbankname - achcountry - active - issystem - businessidentificationcode - country - creditcardexpirationmonth - creditcardexpirationyear - creditcardmasknumber - lasttransactiondatetime - paypalbaid - type - in: query name: expand[] required: false schema: type: array items: type: string enum: - account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - achaccountname - achbankname - achcountry - active - issystem - businessidentificationcode - country - creditcardexpirationmonth - creditcardexpirationyear - creditcardmasknumber - lasttransactiondatetime - paypalbaid - type responses: '200': content: application/json: schema: type: object title: QueryPaymentMethodsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentMethod' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-methods/{key}: get: summary: Retrieve a payment method description: | Retrieve the details of a specific Payment Method object. operationId: queryPaymentMethodByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentMethod' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-method-snapshots: get: summary: List payment method snapshots description: | Lists payment method snapshots. You can use the query parameters to filter, expand, and sort the returned results. **Note**: You must specify a `filter[]` query parameter to query payment method snapshots. operationId: queryPaymentMethodSnapshots parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - country - creditcardcountry - paymentmethodid - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Method Snapshot object does not support expanding any related objects. - in: query name: filter[] required: true schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - country - creditcardcountry - paymentmethodid responses: '200': content: application/json: schema: type: object title: QueryPaymentMethodSnapshotsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentMethodSnapshot' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-method-snapshots/{key}: get: summary: Retrieve a payment method snapshot description: | Retrieve the details of a specific Payment Method Snapshot object. operationId: queryPaymentMethodSnapshotByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Method Snapshot object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentMethodSnapshot' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-runs: get: summary: List payment runs description: | Lists payment runs. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPaymentRuns parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - executeddate - numberofpayments - paymentrunnumber - status - targetdate - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Run object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - executeddate - numberofpayments - paymentrunnumber - status - targetdate responses: '200': content: application/json: schema: type: object title: QueryPaymentRunsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentRun' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-runs/{key}: get: summary: Retrieve a payment run description: | Retrieve the details of a specific Payment Run object. operationId: queryPaymentRunByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Run object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentRun' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-schedules: get: summary: List payment schedules description: | Lists payment schedules. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPaymentSchedules parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - number - accountid - invoiceid - debitmemoid - occurrences - status - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Schedule object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - number - accountid - invoiceid - debitmemoid - occurrences - status responses: '200': content: application/json: schema: type: object title: QueryPaymentSchedulesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentSchedule' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-schedules/{key}: get: summary: Retrieve a payment schedule description: | Retrieve the details of a specific Payment Schedule object. operationId: queryPaymentScheduleByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Schedule object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentSchedule' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-schedule-items: get: summary: List payment schedule items description: | Lists Payment Schedule Item objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPaymentScheduleItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - number - accountid - invoiceid - debitmemoid - paymentscheduleid - scheduleddate - status - paymentid - cancellationreason - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Schedule Item object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - number - accountid - invoiceid - debitmemoid - paymentscheduleid - scheduleddate - status - paymentid - cancellationreason responses: '200': content: application/json: schema: type: object title: QueryPaymentScheduleItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPaymentScheduleItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/payment-schedule-items/{key}: get: summary: Retrieve a payment schedule item description: | Retrieve the details of a specific Payment Schedule Item object. operationId: queryPaymentScheduleItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/) in: header name: zuora-version required: false schema: type: string - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Payment Schedule Item object does not support expanding any related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPaymentScheduleItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balances: get: summary: List prepaid balances description: | Lists Prepaid Balance objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPrepaidBalances parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - startdate - accountid - origsubscriptionid - uom - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - origsubscription description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - startdate - accountid - origsubscriptionid - uom responses: '200': content: application/json: schema: type: object title: QueryPrepaidBalancesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPrepaidBalance' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balances/{key}: get: summary: Retrieve a prepaid balance description: | Retrieve the details of a specific Prepaid Balance object. operationId: queryPrepaidBalanceByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - origsubscription description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPrepaidBalance' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balance-funds: get: summary: List prepaid balance funds description: | Lists prepaid balance funds. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPrepaidBalanceFunds parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - enddate - prepaidbalanceid - sourceid - startdate - vpsummaryid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - prepaidbalance - source - vpsummary description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - enddate - prepaidbalanceid - sourceid - startdate - vpsummaryid responses: '200': content: application/json: schema: type: object title: QueryPrepaidBalanceFundsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPrepaidBalanceFund' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balance-funds/{key}: get: summary: Retrieve a prepaid balance fund description: | Retrieve the details of a specific Prepaid Balance Fund object. operationId: queryPrepaidBalanceFundByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - prepaidbalance - source - vpsummary description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPrepaidBalanceFund' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balance-transactions: get: summary: List prepaid balance transactions description: | Lists prepaid balance transactions. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryPrepaidBalanceTransactions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - accountid - prepaidbalanceid - fundid - sourceid - transactiondate - prepaidbalancetransactiontype - createddate - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - prepaidbalance - fund description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - accountid - prepaidbalanceid - fundid - sourceid - transactiondate - createddate responses: '200': content: application/json: schema: type: object title: QueryPrepaidBalanceTransactionsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedPrepaidBalanceTransaction' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/prepaid-balance-transactions/{key}: get: summary: Retrieve a prepaid balance transaction description: | Retrieve the details of a Prepaid Balance Transaction object. operationId: queryPrepaidBalanceTransactionByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - prepaidbalance - fund description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedPrepaidBalanceTransaction' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/processed-usages: get: summary: List processed usage records description: | Lists Processed Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryProcessedUsages parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - usageid - billingperiodenddate - billingperiodstartdate - in: query name: expand[] required: false schema: type: array items: type: string enum: - usage - invoiceitem - creditmemoitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - usageid - billingperiodenddate - billingperiodstartdate responses: '200': content: application/json: schema: type: object title: QueryProcessedUsagesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedProcessedUsage' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/processed-usages/{key}: get: summary: Retrieve a processed usage record description: | Retrieve the details of a specific Processed Usage Record object. operationId: queryProcessedUsageByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - usage - invoiceitem - creditmemoitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedProcessedUsage' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/products: get: summary: List products description: | Lists Product objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryProducts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - name - effectiveenddate - effectivestartdate - sku - productnumber - category - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplans - productrateplans.productrateplancharges description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - name - effectiveenddate - effectivestartdate - sku - productnumber - category responses: '200': content: application/json: schema: type: object title: QueryProductsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedProduct' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/products/{key}: get: summary: Retrieve a product description: | Retrieve the details of a specific Product object. operationId: queryProductByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplans - productrateplans.productrateplancharges description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedProduct' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plans: get: summary: List product rate plans description: | Lists Product Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryProductRatePlans parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - productid - name - effectivestartdate - effectiveenddate - productrateplannumber - in: query name: expand[] required: false schema: type: array items: type: string enum: - product - productrateplancharges description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - productid - name - effectivestartdate - effectiveenddate - productrateplannumber responses: '200': content: application/json: schema: type: object title: QueryProductRatePlansResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedProductRatePlan' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plans/{key}: get: summary: Retrieve a product rate plan description: | Retrieve the details of a specific Product Rate Plan object. operationId: queryProductRatePlanByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - product - productrateplancharges description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedProductRatePlan' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plan-charges: get: summary: List product rate plan charges description: | Lists Product Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryProductRatePlanCharges parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - billcycleday - chargemodel - productrateplanchargenumber - productrateplanid - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplan description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - billcycleday - chargemodel - chargetype - isprepaid - productrateplanchargenumber - productrateplanid responses: '200': content: application/json: schema: type: object title: QueryProductRatePlanChargesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedProductRatePlanCharge' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plan-charges/{key}: get: summary: Retrieve a product rate plan charge description: | Retrieve the details of a specific Product Rate Plan Charge object. operationId: queryProductRatePlanChargeByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplan - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedProductRatePlanCharge' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plan-charge-tiers: get: summary: List product rate plan charge tiers description: | Lists Product Rate Plan Charge Tier objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryProductRatePlanChargeTiers parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - productrateplanchargeid - productchargedefinitionid - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - productrateplanchargeid - productchargedefinitionid responses: '200': content: application/json: schema: type: object title: QueryProductRatePlanChargeTiersResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedProductRatePlanChargeTier' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/product-rate-plan-charge-tiers/{key}: get: summary: Retrieve a product rate plan charge tier description: | Retrieve the details of a specific Product Rate Plan Charge Tier object. operationId: queryProductRatePlanChargeTierByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - productrateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedProductRatePlanChargeTier' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rate-plans: get: summary: List rate plans description: | Lists Rate Plan objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryRatePlans parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - productid - amendmentid - subscriptionid - subscriptionownerid - externallymanagedplanid - subscriptionrateplannumber - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - productrateplan - rateplancharges description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - productid - amendmentid - subscriptionid - subscriptionownerid - invoiceownerid - externallymanagedplanid - originalrateplanid - subscriptionofferid - subscriptionrateplannumber responses: '200': content: application/json: schema: type: object title: QueryRatePlansResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRatePlan' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rate-plans/{key}: get: summary: Retrieve a rate plan description: | Retrieve the details of a specific Rate Plan object. operationId: queryRatePlanByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - subscription - productrateplan - rateplancharges description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRatePlan' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rate-plan-charges: get: summary: List rate plan charges description: | Lists Rate Plan Charge objects. You can use the query parameters to filter, expand, and sort the returned results. **Note**: You must specify a `filter[]` query parameter to query rate plan charges. operationId: queryRatePlanCharges parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - rateplanid - chargenumber - invoicescheduleid - isprepaid - originalid - productchargedefinitionid - in: query name: expand[] required: false schema: type: array items: type: string enum: - rateplan - productrateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: true schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - rateplanid - chargenumber - invoicescheduleid - isprepaid - originalid - subscriptionid - subscriptionownerid - invoiceownerid - productchargedefinitionid responses: '200': content: application/json: schema: type: object title: QueryRatePlanChargesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRatePlanCharge' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rate-plan-charges/{key}: get: summary: Retrieve a rate plan charge description: | Retrieve the details of a specific Rate Plan Charge object. operationId: queryRatePlanChargeByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - rateplan - productrateplancharge description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRatePlanCharge' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rating-results: get: summary: List rating results description: | Lists Rating Result objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryRatingResults parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - subscriptionid - rateplanchargeid - servicestartdate - serviceenddate - status - ispartial - invoiceitemid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - rateplancharge - subscription - invoiceitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - subscriptionid - rateplanchargeid - servicestartdate - serviceenddate - status - ispartial - invoiceitemid responses: '200': content: application/json: schema: type: object title: QueryRatingResultsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRatingResult' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/rating-results/{key}: get: summary: Retrieve a rating result description: | Retrieve the details of a specific Rating Result object. operationId: queryRatingResultByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - rateplancharge - subscription - invoiceitem description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRatingResult' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refunds: get: summary: List refunds description: | Lists Refund objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryRefunds parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - paymentmethodsnapshotid - amount - paymentmethodid - reasoncode - refunddate - refundnumber - sourcetype - status - type - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - account.billto - account.soldto - paymentmethod - refundapplications - refundapplications.payment - refundapplications.refundapplicationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - paymentmethodsnapshotid - amount - paymentmethodid - reasoncode - refunddate - refundnumber - sourcetype - status - type responses: '200': content: application/json: schema: type: object title: QueryRefundsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRefund' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refunds/{key}: get: summary: Retrieve a refund description: | Retrieve the details of a specific Refund object. operationId: queryRefundByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - account.billto - account.soldto - paymentmethod - refundapplications - refundapplications.payment - refundapplications.refundapplicationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRefund' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refund-applications: get: summary: List refund applications description: | Lists Refund Application objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryRefundApplications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - applicationgroupid - creditmemoid - effectivedate - paymentid - refundid - in: query name: expand[] required: false schema: type: array items: type: string enum: - refund - payment - refundapplicationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - applicationgroupid - creditmemoid - effectivedate - paymentid - refundid responses: '200': content: application/json: schema: type: object title: QueryRefundApplicationsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRefundApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refund-applications/{key}: get: summary: Retrieve a refund application description: | Retrieve the details of a specific Refund Application object. operationId: queryRefundApplicationByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - refund - payment - refundapplicationitems description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRefundApplication' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refund-application-items: get: summary: List refund application items description: | Lists Refund Application Item objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryRefundApplicationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - in: query name: expand[] required: false schema: type: array items: type: string enum: - refundapplication description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate responses: '200': content: application/json: schema: type: object title: QueryRefundApplicationItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedRefundApplicationItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/refund-application-items/{key}: get: summary: Retrieve a refund application item description: | Retrieve the details of a specific Refund Application Item object. operationId: queryRefundApplicationItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - refundapplication description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedRefundApplicationItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/summarystatementruns: get: summary: List summary statement runs description: | Lists statement runs. You can use the query parameters to filter, expand, and sort the returned results. operationId: getSummaryStatementRuns parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string enum: - endDate - startDate - statementRunNumber description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string enum: - accountId - id - startDate - statementRunNumber - status description: A case-sensitive filter on the list. responses: '200': description: | OK content: application/json: examples: response: value: accountId: 402881869169397401916d8ff8d218c5 createdbyId: 8a90e0828097f4a80180982735ff041d createdDate: '2024-09-03T20:20:55-10:00' emailStatus: Pending endDate: '2024-09-03' id: 8a90f17a91b7e1800191bbb176a243da startDate: '2024-09-03' statementDate: '2024-09-03' statementNumber: SS-00001979 statementRunId: 8a90b44891b7e1670191bbb16cef028a status: Completed updatedById: 8a90e0828097f4a80180982735ff041d updatedDate: '2024-08-20 10:13:57.586' success: true schema: $ref: '#/components/schemas/SummaryStatementOQResponse' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': description: | Invalid Input content: application/json: example: message: INVALID VALUE. The account number 123xProxy is invalid. schema: $ref: '#/components/schemas/ProxyBadRequestResponse' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': description: '' content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/summarystatementruns/{key}: get: summary: Retrieve a summary statement run description: | Retrieves a statement run by using the statement run ID or number. operationId: getSummaryStatementRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Statement run ID or number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string enum: - endDate - startDate - statementRunNumber description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string enum: - accountId - id - startDate - statementRunNumber - status description: A case-sensitive filter on the list. responses: '200': content: application/json: examples: response: value: accountId: 402881869169397401916d8ff8d218c5 statementRunNumber: SSR-00000004 targetAccountCategory: AllAccounts runType: AdHoc batchName: Batch51 billCycleDay: null dateRangeType: PreviousThreeCalendarMonth startDate: '2024-05-01 19:13:57' endDate: '2024-07-31 19:13:57' autoEmailEnabled: false description: HelloWorld status: Pending createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2024-08-19 19:13:57' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2024-08-20 10:13:57.586' success: true schema: $ref: '#/components/schemas/SummaryStatementOQResponse' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: message: INVALID VALUE. The account number 123xProxy is invalid. schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/summarystatements: get: summary: List summary statements description: | Lists summary statements. operationId: getSummaryStatements parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string enum: - endDate - statementDate - statementNumber description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string enum: - accountId - id - startDate - statementDate - statementNumber - statementRunId - status - emailStatus description: A case-sensitive filter on the list. responses: '200': content: application/json: examples: response: value: accountId: 402881869169397401916d8ff8d218c5 createdById: 8a90e0828097f4a80180982735ff041d createdDate: '2024-09-03T20:20:55-10:00' emailStatus: Pending endDate: '2024-09-03' id: 8a90f17a91b7e1800191bbb176a243da startDate: '2024-09-03' statementDate: '2024-09-03' statementNumber: SS-00001979 statementRunId: 8a90b44891b7e1670191bbb16cef028a status: Completed updatedById: 8a90e0828097f4a80180982735ff041d updatedDate: '2024-08-20 10:13:57.586' success: true schema: $ref: '#/components/schemas/SummaryStatementOQResponse' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: message: Bad Request schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/summarystatements/{key}: get: summary: Retrieve a summary statement description: | Retrieves a statement based on the specified summary statement key. operationId: getSummaryStatement parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Statement ID or number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - endDate - statementDate - statementNumber - in: query name: expand[] required: false schema: type: array items: type: string enum: - createdById - createdDate - deleted - endDate - fileId - updatedById - updatedDate - errorCategory - errorMessage description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string enum: - accountId - id - startDate - statementDate - statementNumber - statementRunId - status - emailStatus description: A case-sensitive filter on the list. responses: '200': content: application/json: examples: response: value: accountId: 402881869169397401916d8ff8d218c5 createdById: 8a90e0828097f4a80180982735ff041d createdDate: '2024-09-03T20:20:55-10:00' emailStatus: Pending endDate: '2024-09-03' id: 8a90f17a91b7e1800191bbb176a243da startDate: '2024-09-03' statementDate: '2024-09-03' statementNumber: SS-00001979 statementRunId: 8a90b44891b7e1670191bbb16cef028a status: Completed updatedById: 8a90e0828097f4a80180982735ff041d updatedDate: '2024-08-20 10:13:57.586' success: true schema: $ref: '#/components/schemas/SummaryStatementOQResponse' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: message: INVALID VALUE. The account number 123xProxy is invalid. schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/subscriptions: get: summary: List subscriptions description: | Lists Subscription objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: querySubscriptions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - contracteffectivedate - creatoraccountid - creatorinvoiceownerid - invoiceownerid - name - originalid - previoussubscriptionid - renewalterm - status - islatestversion - subscriptionversionamendmentid - termenddate - termstartdate - version - cmrr - externallymanagedby - invoicescheduleid - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - invoiceowner - billtocontact - invoiceitems - rateplans - rateplans.rateplancharges - rateplans.rateplancharges.rateplanchargetiers - account.billto - account.soldto - account.paymentmethods description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - contracteffectivedate - creatoraccountid - creatorinvoiceownerid - invoiceownerid - name - originalid - previoussubscriptionid - renewalterm - status - islatestversion - subscriptionversionamendmentid - termenddate - termstartdate - version - cmrr - externallymanagedby - invoicescheduleid - quotenumber__qt responses: '200': content: application/json: schema: type: object title: QuerySubscriptionsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedSubscription' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/subscriptions/{key}: get: summary: Retrieve a subscription description: | Retrieve the details of a specific Subscription object. operationId: querySubscriptionByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - invoiceowner - billtocontact - invoiceitems - rateplans - rateplans.rateplancharges - rateplans.rateplancharges.rateplanchargetiers - account.billto - account.soldto - account.paymentmethods description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedSubscription' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/taxation-items: get: summary: List taxation items description: | Lists Taxation Item objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryTaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - invoiceitemid - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Taxation Item object does not support expanding related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - invoiceitemid responses: '200': content: application/json: schema: type: object title: QueryTaxationItemsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedTaxationItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/taxation-items/{key}: get: summary: Retrieve a taxation item description: | Retrieve the details of a specific Taxation Item object. operationId: queryTaxationItemByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string description: |- Allows you to expand responses by including related object information in a single call. The Taxation Item object does not support expanding related objects. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedTaxationItem' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/usages: get: summary: List usage records description: | Lists Usage Record objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryUsages parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - updateddate - accountid - accountnumber - enddatetime - quantity - rbestatus - startdatetime - uom - in: query name: expand[] required: false schema: type: array items: type: string enum: - account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - updateddate - accountid - accountnumber - enddatetime - quantity - rbestatus - startdatetime - uom responses: '200': content: application/json: schema: type: object title: QueryUsagesResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedUsage' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/usages/{key}: get: summary: Retrieve a usage record description: | Retrieve the details of a specific Usage Record object. operationId: queryUsageByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedUsage' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/validity-period-summaries: get: summary: List validity period summaries description: | Lists Validity Period Summary objects. You can use the query parameters to filter, expand, and sort the returned results. operationId: queryValidityPeriodSummarys parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. Supported sortable fields: - id - prepaidbalanceid - startdate - subscriptionnumber - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - prepaidbalance description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: |- A case-sensitive filter on the list. Supported filterable fields: - id - prepaidbalanceid - startdate - subscriptionnumber responses: '200': content: application/json: schema: type: object title: QueryValidityPeriodSummarysResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: $ref: '#/components/schemas/ExpandedValidityPeriodSummary' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/validity-period-summaries/{key}: get: summary: Retrieve a validity period summary description: | Retrieve the details of a specific Validity Period Summary object. operationId: queryValidityPeriodSummaryByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Object ID or Number. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: sort[] required: false schema: type: array items: type: string description: |- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: expand[] required: false schema: type: array items: type: string enum: - account - prepaidbalance description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExpandedValidityPeriodSummary' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/{custom-object-name}: get: summary: List custom objects description: | Lists custom objects. You can use the query parameters to filter, expand, and sort the returned results. The name of a custom object is in the `{namespace}__{objectname}s` format, for example, `default__cars`. **Note**: Sorting queried custom objects by ID is not supported. operationId: queryCustomObjects parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Custom Object Name with NameSpace, e.g. default__cars in: path name: custom-object-name required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: type: object title: QueryCustomObjectsResponse description: '' nullable: false additionalProperties: false properties: nextPage: type: string description: | A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. nullable: true data: type: array items: type: object additionalProperties: false description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /object-query/{custom-object-name}/{key}: get: summary: Retrieve a custom object description: | Retrieve the details of a specific custom object. The name of a custom object is in the `{namespace}__{objectname}s` format, for example, `default__cars`. operationId: queryCustomObjectBykey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - description: Custom Object Name with NameSpace, for example, `default__cars`. in: path name: custom-object-name required: true schema: type: string - description: Object ID. in: path name: key required: true schema: type: string - in: query name: pageSize required: false schema: type: integer minimum: 1 maximum: 99 default: 10 description: The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: cursor required: false schema: type: string description: A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. - in: query name: expand[] required: false schema: type: array items: type: string description: Allows you to expand responses by including related object information in a single call. - in: query name: filter[] required: false schema: type: array items: type: string description: A case-sensitive filter on the list. responses: '200': content: application/json: schema: type: object additionalProperties: false description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: example: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: '' headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: example: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonOQErrorResponse' description: Unauthorized headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Object Queries x-accepts: application/json /query/jobs: get: description: | Returns a list of [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) jobs that have been created in your Zuora tenant. You can filter the list by status. If you are an administrator, you can retrieve all the query jobs in your tenant. Otherwise, you can only retrieve your own query jobs. operationId: GET_DataQueryJobs parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | Filters the list of query jobs by status. in: query name: queryStatus required: false schema: enum: - accepted - in_progress - completed - failed - cancelled type: string - description: | The number of records returned per page in the response. in: query name: pageSize required: false schema: default: 20 maximum: 1000 type: integer responses: '200': content: application/json: examples: response: value: data: - createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 id: bf3b5640-ddd1-4b4f-9a81-906ec2b84a89 query: SELECT s.id FROM Subscription s JOIN RatePlan rp ON s.id = rp.subscriptionid WHERE rp.name = 'Premium Monthly' queryStatus: in_progress remainingRetries: 3 sourceData: LIVE updatedOn: '2018-08-17T13:14:38.855Z' useIndexJoin: false - createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 dataFile: https://example.s3.us-west-2.amazonaws.com/3a3e85c4-96e7-486b-ae02-827120104301_24921638725108715.json?X-Amz-Security-Token=... id: 3a3e85c4-96e7-486b-ae02-827120104301 outputRows: 24516 processingTime: 9212 query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 queryStatus: completed remainingRetries: 3 sourceData: LIVE updatedOn: '2018-08-17T13:14:19.17Z' useIndexJoin: false schema: $ref: '#/components/schemas/GetDataQueryJobsResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: List data query jobs tags: - Data Queries post: description: | Submits a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) to be performed by Zuora and creates a query job. You can use [Retrieve a data query job](#operation/GET_DataQueryJob) to track the status of the query job and obtain the URL of the query results. operationId: POST_DataQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitDataQueryRequest' required: true responses: '200': content: application/json: examples: response: value: data: id: 5948abde-b875-4d06-ad07-c2138853d8bc query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 useIndexJoin: false sourceData: LIVE queryStatus: accepted remainingRetries: 3 retries: 3 updatedOn: '2024-07-09T09:47:49.675Z' createdOn: '2024-07-09T09:47:49.675Z' createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 createdByUserEmail: amy@mycompany.com schema: $ref: '#/components/schemas/SubmitDataQueryResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '400': content: application/json: examples: response: value: code: 400 message: Unable to process JSON schema: $ref: '#/components/schemas/DataQueryErrorResponse' description: Bad Request headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Submit a data query tags: - Data Queries /query/jobs/{job-id}: delete: description: | Cancels a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) job, which prevents Zuora from performing the query. This operation is only applicable if the status of the query job is `accepted` or `in_progress`. operationId: DELETE_DataQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | Internal identifier of the query job. in: path name: job-id required: true schema: format: uuid maxLength: 64 minLength: 64 type: string responses: '200': content: application/json: examples: response: value: data: createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 id: 3a3e85c4-96e7-486b-ae02-827120104301 query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 queryStatus: cancelled remainingRetries: 3 sourceData: LIVE updatedOn: '2018-08-17T13:22:16.965Z' useIndexJoin: false schema: $ref: '#/components/schemas/DeleteDataQueryJobResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '400': content: application/json: examples: response: value: code: 1003 message: Query job c20a8ff4-3960-4c85-b067-d5259035f523 is not in accepted or in_progress status schema: $ref: '#/components/schemas/DataQueryErrorResponse' description: Bad Request headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Cancel a data query job tags: - Data Queries get: description: | Retrieves a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) job. You can use this operation to track the status of the query job and obtain the URL of the query results. If you are an administrator, you can retrieve every query job in your tenant. If you are a non-admin user and try to retrieve a query job that you are not the owner of, you will get a 403 response indicating that you are forbidden from viewing this job. As a non-admin user, you can only retrieve your own query job. operationId: GET_DataQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | Internal identifier of the query job. in: path name: job-id required: true schema: format: uuid maxLength: 36 minLength: 36 type: string responses: '200': content: application/json: examples: response: value: data: createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 dataFile: https://example.s3.us-west-2.amazonaws.com/3a3e85c4-96e7-486b-ae02-827120104301_24921638725108715.json?X-Amz-Security-Token=... id: 3a3e85c4-96e7-486b-ae02-827120104301 outputRows: 24516 processingTime: 9212 query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 queryStatus: completed remainingRetries: 3 sourceData: LIVE updatedOn: '2018-08-17T13:14:19.17Z' useIndexJoin: false schema: $ref: '#/components/schemas/GetDataQueryJobResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '403': content: application/json: examples: response: value: code: 1009 message: Access denied for restricted job ea50af05-6163-47e1-bf9b-c8e10648d8a3 schema: $ref: '#/components/schemas/DataQueryErrorResponse' description: Forbidden headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '404': content: application/json: examples: response: value: code: 1001 message: 'No such query: 1e8e8586-5366-4cdf-a01d-fae3b2cf8427' schema: $ref: '#/components/schemas/DataQueryErrorResponse' description: Not Found headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Retrieve a data query job tags: - Data Queries /v1/batch-query/: post: description: | Submits an AQuA job that contains an aggregated list of ZOQL and Export ZOQL queries. operationId: POST_BatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitBatchQueryRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8ad08f06909293cd01909613f23549e4 status: submitted version: 1 format: CSV batches: - batchId: 8ad08f06909293cd01909613f23549e5 status: pending localizedStatus: pending apiVersion: '145.0' recordCount: 0 batchType: zoql full: true query: select AccountNumber, BillCycleDay from Account encrypted: none useLastCompletedJobQueries: false offset: 0 schema: $ref: '#/components/schemas/SubmitBatchQueryResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Submit an aggregate query job tags: - Aggregate Queries /v1/batch-query/jobs/partner/{partner}/project/{project}: get: description: | Returns the details of the last completed job. The completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA job finder. operationId: GET_LastBatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The unique ID of a data integration partner. in: path name: partner required: true schema: type: string - description: | The unique ID of a data integration project for a particular partner. in: path name: project required: true schema: type: string responses: '200': content: application/json: examples: response: value: batches: - apiVersion: '60.0' batchId: 402881824835bb2a01483c1e678c025b batchType: zoqlexport fileId: 402881824835bb2a01483c1e67c7025d full: false message: '' name: AccountingPeriod query: select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod recordCount: 0 status: completed encrypted: none format: CSV id: 402881824835bb2a01483c1e678a025a name: Example partner: salesforce project: 00170000011K3Ub sourceData: LIVE startTime: '2014-09-03 08:24:58' status: completed version: '1.1' schema: $ref: '#/components/schemas/GetAggregateQueryJobResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Retrieve the last completed aggregate query job tags: - Aggregate Queries /v1/batch-query/jobs/{jobid}: delete: description: | Cancels the current AQuA job, only if the job is not complete. If the job is complete, an error is thrown. operationId: DELETE_BatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | Internal identifier of the query job. in: path name: jobid required: true schema: type: string responses: '200': content: application/json: examples: response: value: batches: - batchId: e20b07474688ad5001468daf10ea01df batchType: zoqlexport fileId: e20b07474688ad5001468daf155f01f5 message: '' name: InvoiceItemAdjustment query: select AccountingCode,CancelledDate,CreatedDate,Id,InvoiceId,InvoiceItemName, InvoiceNumber,SourceType,AdjustmentNumber,ServiceStartDate,ServiceEndDate,AdjustmentDate, Amount,Status,AccountId,SourceId,Type,ReasonCode, UpdatedDate from InvoiceItemAdjustment recordCount: 1580 status: completed - batchId: e20b07474688ad5001468daf10ec01e0 batchType: zoqlexport fileId: e20b07474688ad5001468daf166601f6 message: '' name: InvoiceAdjustment query: select AccountingCode,CancelledOn,CreatedDate,Id,ImpactAmount,Invoice.Id, InvoiceNumber,AdjustmentNumber,AdjustmentDate,Amount,Status,Account.Id,Type,ReasonCode, UpdatedDate from InvoiceAdjustment recordCount: 411 status: completed encrypted: none format: CSV id: e20b07474688ad5001468daf10e501de name: June10 sourceData: LIVE status: cancelled version: '1.1' schema: $ref: '#/components/schemas/DeleteBatchQueryJobResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Cancel a running aggregate query job tags: - Aggregate Queries get: description: | Retrieves an aggregate query using the Job ID. Note that the completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA job finder. operationId: GET_BatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | Internal identifier of the query job. in: path name: jobid required: true schema: type: string responses: '200': content: application/json: examples: response: value: batches: - apiVersion: '60.0' batchId: 402881824835bb2a01483c19f7da0257 batchType: zoqlexport fileId: 402881824835bb2a01483c19f8190259 full: true message: '' name: AccountingPeriod query: select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod recordCount: 1 status: completed encrypted: none format: CSV id: 402881824835bb2a01483c19f7d70256 name: Example partner: salesforce project: 00170000011K3Ub sourceData: LIVE startTime: '2014-09-03 08:20:07' status: completed version: '1.1' schema: $ref: '#/components/schemas/GetAggregateQueryJobResponse' description: OK headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Retrieve an aggregate query job tags: - Aggregate Queries /deployment-manager/deployment_artifacts: get: description: | Download a template for migration in the Deployment manager from the source tenant to the target tenant. operationId: GET_DownloadDeploymentTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Id which template needs to be downloaded. in: query name: deployment_template_id required: true schema: type: string responses: '200': content: application/json: examples: response: value: {} schema: $ref: '#/components/schemas/JsonNode' description: Successfully downloaded the template. headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Bad request headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Unauthorized headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Forbidden headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Id is invalid headers: Content-Encoding: description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API call. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. schema: maxLength: 64 type: string summary: Download a template tags: - Configuration Templates /deployment-manager/deployment_artifacts/compare: post: description: | To Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant. operationId: POST_CompareTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Customers need to specify tenant ID. in: query name: tenant required: true schema: type: string requestBody: content: multipart/form-data: schema: properties: template: description: Template contains the config metadata and target tenant information. format: binary type: string type: object responses: '200': content: application/json: examples: response: value: customFields: - errors: [] originalPayload: count: 2 definitions: Account: schema: additionalProperties: false indexed: - Last_Token_Transaction_Date__c - idx_date_1__c properties: CollectionsAgent__c: createdDate: '2022-08-22T18:16:38.000Z' default: abc description: '' label: Collections Agent maxLength: 255 type: string updatedDate: '2022-08-22T18:16:38.000Z' InCollections__c: createdDate: '2022-08-18T12:38:04.000Z' description: '' label: